AirshipDotNet.IAirshipMessageCenter Interface Reference

Airship Message Center interface. More...

Inheritance diagram for AirshipDotNet.IAirshipMessageCenter:

Public Member Functions
Task< List< Message > >	GetMessages ()
	Gets all messages from the message center.
Task< Message?>	GetMessage (string messageId)
	Gets a specific message by ID.
Task< int >	GetUnreadCount ()
	Gets the unread message count.
Task< int >	GetCount ()
	Gets the total message count.
Task	MarkRead (params string[] messageIds)
	Marks messages as read.
Task	Delete (params string[] messageIds)
	Deletes messages.
Task	Display ()
	Displays the message center.
Task	DisplayMessage (string messageId)
	Displays a specific message.

Events
EventHandler< MessageCenterEventArgs >	OnMessageCenterDisplay
	Add/remove the Message Center display listener.
EventHandler< EventArgs >	OnMessagesUpdated
	Add/remove the Message Center updated listener.

Detailed Description

Airship Message Center interface.

Member Function Documentation

Delete()

Task AirshipDotNet.IAirshipMessageCenter.Delete

(

params string[]

messageIds

)

Deletes messages.

Parameters

messageIds

The message IDs to delete.

Implemented in AirshipDotNet.Platforms.Android.Modules.AirshipMessageCenter, and AirshipDotNet.Platforms.iOS.Modules.AirshipMessageCenter.

Display()

Task AirshipDotNet.IAirshipMessageCenter.Display

(

)

Displays the message center.

Implemented in AirshipDotNet.Platforms.Android.Modules.AirshipMessageCenter, and AirshipDotNet.Platforms.iOS.Modules.AirshipMessageCenter.

DisplayMessage()

Task AirshipDotNet.IAirshipMessageCenter.DisplayMessage

(

string

messageId

)

Displays a specific message.

Parameters

messageId

The message ID to display.

Implemented in AirshipDotNet.Platforms.Android.Modules.AirshipMessageCenter, and AirshipDotNet.Platforms.iOS.Modules.AirshipMessageCenter.

GetCount()

Task< int > AirshipDotNet.IAirshipMessageCenter.GetCount

(

)

Gets the total message count.

Returns

The total number of messages.

Implemented in AirshipDotNet.Platforms.Android.Modules.AirshipMessageCenter, and AirshipDotNet.Platforms.iOS.Modules.AirshipMessageCenter.

GetMessage()

Task< Message?> AirshipDotNet.IAirshipMessageCenter.GetMessage

(

string

messageId

)

Gets a specific message by ID.

Parameters

messageId

The message ID.

Returns

The message or null if not found.

Implemented in AirshipDotNet.Platforms.Android.Modules.AirshipMessageCenter, and AirshipDotNet.Platforms.iOS.Modules.AirshipMessageCenter.

GetMessages()

Task< List< Message > > AirshipDotNet.IAirshipMessageCenter.GetMessages

(

)

Gets all messages from the message center.

Returns

List of messages.

Implemented in AirshipDotNet.Platforms.Android.Modules.AirshipMessageCenter, and AirshipDotNet.Platforms.iOS.Modules.AirshipMessageCenter.

GetUnreadCount()

Task< int > AirshipDotNet.IAirshipMessageCenter.GetUnreadCount

(

)

Gets the unread message count.

Returns

The number of unread messages.

Implemented in AirshipDotNet.Platforms.Android.Modules.AirshipMessageCenter, and AirshipDotNet.Platforms.iOS.Modules.AirshipMessageCenter.

MarkRead()

Task AirshipDotNet.IAirshipMessageCenter.MarkRead

(

params string[]

messageIds

)

Marks messages as read.

Parameters

messageIds

The message IDs to mark as read.

Implemented in AirshipDotNet.Platforms.Android.Modules.AirshipMessageCenter, and AirshipDotNet.Platforms.iOS.Modules.AirshipMessageCenter.

Event Documentation

OnMessageCenterDisplay

EventHandler<MessageCenterEventArgs> AirshipDotNet.IAirshipMessageCenter.OnMessageCenterDisplay

Add/remove the Message Center display listener.

OnMessagesUpdated

EventHandler<EventArgs> AirshipDotNet.IAirshipMessageCenter.OnMessagesUpdated

Add/remove the Message Center updated listener.