MessageCenterInboxBaseProtocol

@objc(UAMessageCenterInboxProtocol)
public protocol MessageCenterInboxBaseProtocol : Sendable

Airship Message Center inbox base protocol.

  • _getMessages() Asynchronous

    Gets the list of messages in the inbox.

    Declaration

    Swift

    @objc(getMessagesWithCompletionHandler:)
func _getMessages() async -> [MessageCenterMessage]

    Return Value

    the list of messages in the inbox.

  • _getUser() Asynchronous

    Gets the user associated to the Message Center if there is one associated already.

    Declaration

    Swift

    @objc(getUserWithCompletionHandler:)
func _getUser() async -> MessageCenterUser?

    Return Value

    the user associated to the Message Center, otherwise nil.

  • _getUnreadCount() Asynchronous

    Gets the number of messages that are currently unread.

    Declaration

    Swift

    @objc(getUnreadCountWithCompletionHandler:)
func _getUnreadCount() async -> Int

    Return Value

    the number of messages that are currently unread.

  • refreshMessages() Asynchronous

    Refreshes the list of messages in the inbox.

    Declaration

    Swift

    @discardableResult
@objc
func refreshMessages() async -> Bool

    Return Value

    true if the messages was refreshed, otherwise false.

  • markRead(messages:) Asynchronous

    Marks messages read.

    Declaration

    Swift

    @objc
func markRead(messages: [MessageCenterMessage]) async

    Parameters

    messages

    The list of messages to be marked read.
  • markRead(messageIDs:) Asynchronous

    Marks messages read by message IDs.

    Declaration

    Swift

    @objc
func markRead(messageIDs: [String]) async

    Parameters

    messageIDs

    The list of message IDs for the messages to be marked read.
  • delete(messages:) Asynchronous

    Marks messages deleted.

    Declaration

    Swift

    @objc
func delete(messages: [MessageCenterMessage]) async

    Parameters

    messages

    The list of messages to be marked deleted.
  • delete(messageIDs:) Asynchronous

    Marks messages deleted by message IDs.

    Declaration

    Swift

    @objc
func delete(messageIDs: [String]) async

    Parameters

    messageIDs

    The list of message IDs for the messages to be marked deleted.
  • message(forBodyURL:) Asynchronous

    Returns the message associated with a particular URL.

    Declaration

    Swift

    @objc
func message(forBodyURL bodyURL: URL) async -> MessageCenterMessage?

    Parameters

    bodyURL

    The URL of the message.

    Return Value

    The associated MessageCenterMessage object or nil if a message was unable to be found.

  • message(forID:) Asynchronous

    Returns the message associated with a particular ID.

    Declaration

    Swift

    @objc
func message(forID messageID: String) async -> MessageCenterMessage?

    Parameters

    messageID

    The message ID.

    Return Value

    The associated MessageCenterMessage object or nil if a message was unable to be found.