Common Airship Interface. More...

Inheritance diagram for AirshipDotNet.IAirship:

Public Member Functions
void	EnableFeatures (Features features)
	Enables particular features.

void	DisableFeatures (Features features)
	Disables particular features.

bool	IsFeatureEnabled (Features feature)
	Indicates whether particular features are enabled.

bool	IsAnyFeatureEnabled ()
	Indicates whether any feature is enabled.

void	GetNamedUser (Action< string > namedUser)
	Gets the named user ID.

void	ResetContact ()
	Reset Contacts.

void	IdentifyContact (string namedUserId)
	Sets the named user ID.

TagEditor	EditDeviceTags ()
	Edit the device tags.

void	AddCustomEvent (Analytics.CustomEvent customEvent)
	Add a custom event.

void	TrackScreen (string screen)
	track a screen for a specific app screen

void	AssociateIdentifier (string key, string identifier)
	Associate a custom identifier.

void	DisplayMessageCenter ()
	Displays the message center.

void	DisplayMessage (string messageId)
	Displays a specific message.

void	MarkMessageRead (string messageId)
	Mark a specific message as read.

void	DeleteMessage (string messageId)
	Delete a specific message.

void	MessageCenterUnreadCount (Action< int > unreadMessageCount)
	Get the message center unread count.

void	MessageCenterCount (Action< int > messageCount)
	Get the total count of message center messages.

void	InboxMessages (Action< List< MessageCenter.Message > > messages)
	Get the list of messages contained in the messages center.

TagGroupsEditor	EditContactTagGroups ()
	Returns an editor for named user tag groups.

TagGroupsEditor	EditChannelTagGroups ()
	Returns an editor for channel tag groups.

AttributeEditor	EditChannelAttributes ()
	Edit channel attributes.

AttributeEditor	EditContactAttributes ()
	Edit contact attributes.

ChannelSubscriptionListEditor	EditChannelSubscriptionLists ()
	Edit channel subscription lists.

ContactSubscriptionListEditor	EditContactSubscriptionLists ()
	Edit contact subscription list.

Properties
bool	UserNotificationsEnabled `[get, set]`
	Indicates whether user notifications are enabled.

Features	EnabledFeatures `[get, set]`
	Currently enabled features.

IEnumerable< string >	Tags `[get]`
	Gets the tags currently set for the device.

string	ChannelId `[get]`
	Get the channel ID for the device.

bool	InAppAutomationPaused `[get, set]`
	Gets or sets whether In-App Automation is paused.

TimeSpan	InAppAutomationDisplayInterval `[get, set]`
	Gets or sets the In-App Automation display interval.

Events
EventHandler< ChannelEventArgs >	OnChannelCreation
	Add/remove the channel creation event listener.

EventHandler< PushNotificationStatusEventArgs >	OnPushNotificationStatusUpdate
	Add/remove the push notification status listener.

EventHandler< DeepLinkEventArgs >	OnDeepLinkReceived
	Add/remove the deep link event listener.

EventHandler< MessageCenterEventArgs >	OnMessageCenterDisplay
	Add/remove the message center display event listener.

EventHandler	OnMessageCenterUpdated
	Add/remove the Inbox updated event listener.

Detailed Description

Common Airship Interface.

Member Function Documentation

◆ AddCustomEvent()

void AirshipDotNet.IAirship.AddCustomEvent ( Analytics.CustomEvent customEvent )

Add a custom event.

Parameters

customEvent The CustomEvent to add.

Implemented in AirshipDotNet.Airship, and AirshipDotNet.Airship.

◆ AssociateIdentifier()

void AirshipDotNet.IAirship.AssociateIdentifier	(	string	key,
		string	identifier )

Associate a custom identifier.

Previous identifiers will be replaced by the new identifiers each time AssociateIdentifier is called. It is a set operation.

Parameters

key	The custom key for the identifier.
identifier	The value of the identifier, or `null` to remove the identifier.

Implemented in AirshipDotNet.Airship, and AirshipDotNet.Airship.

◆ DeleteMessage()

void AirshipDotNet.IAirship.DeleteMessage ( string messageId )

Delete a specific message.

Parameters

messageId The identifier for the message to delete.

Implemented in AirshipDotNet.Airship, and AirshipDotNet.Airship.

◆ DisableFeatures()

void AirshipDotNet.IAirship.DisableFeatures ( Features features )

Disables particular features.

Parameters

features The features.

Implemented in AirshipDotNet.Airship, and AirshipDotNet.Airship.

◆ DisplayMessage()

void AirshipDotNet.IAirship.DisplayMessage ( string messageId )

Displays a specific message.

Parameters

messageId The identifier for the message to display.

Implemented in AirshipDotNet.Airship, and AirshipDotNet.Airship.

◆ DisplayMessageCenter()

void AirshipDotNet.IAirship.DisplayMessageCenter ( )

Displays the message center.

Implemented in AirshipDotNet.Airship, and AirshipDotNet.Airship.

◆ EditChannelAttributes()

AttributeEditor AirshipDotNet.IAirship.EditChannelAttributes ( )

Edit channel attributes.

Returns: An AttributeEditor for channel attributes.

Implemented in AirshipDotNet.Airship, and AirshipDotNet.Airship.

◆ EditChannelSubscriptionLists()

ChannelSubscriptionListEditor AirshipDotNet.IAirship.EditChannelSubscriptionLists ( )

Edit channel subscription lists.

Returns: An SubscriptionListsEditor for channel subscription lists.

Implemented in AirshipDotNet.Airship, and AirshipDotNet.Airship.

◆ EditChannelTagGroups()

TagGroupsEditor AirshipDotNet.IAirship.EditChannelTagGroups ( )

Returns an editor for channel tag groups.

Returns: A TagGroupsEditor for channel tag groups.

Implemented in AirshipDotNet.Airship, and AirshipDotNet.Airship.

◆ EditContactAttributes()

AttributeEditor AirshipDotNet.IAirship.EditContactAttributes ( )

Edit contact attributes.

Returns: An AttributeEditor for contact attributes.

Implemented in AirshipDotNet.Airship, and AirshipDotNet.Airship.

◆ EditContactSubscriptionLists()

ContactSubscriptionListEditor AirshipDotNet.IAirship.EditContactSubscriptionLists ( )

Edit contact subscription list.

Returns: An SubscriptionListsEditor for contact subscription lists.

Implemented in AirshipDotNet.Airship, and AirshipDotNet.Airship.

◆ EditContactTagGroups()

TagGroupsEditor AirshipDotNet.IAirship.EditContactTagGroups ( )

Returns an editor for named user tag groups.

Returns: A TagGroupsEditor for named user tag groups.

Implemented in AirshipDotNet.Airship, and AirshipDotNet.Airship.

◆ EditDeviceTags()

TagEditor AirshipDotNet.IAirship.EditDeviceTags ( )

Edit the device tags.

Returns: A TagEditor for editing device tags.

Implemented in AirshipDotNet.Airship, and AirshipDotNet.Airship.

◆ EnableFeatures()

void AirshipDotNet.IAirship.EnableFeatures ( Features features )

Enables particular features.

Parameters

features The features.

Implemented in AirshipDotNet.Airship, and AirshipDotNet.Airship.

◆ GetNamedUser()

void AirshipDotNet.IAirship.GetNamedUser ( Action< string > namedUser )

Gets the named user ID.

The named user ID.

Implemented in AirshipDotNet.Airship, and AirshipDotNet.Airship.

◆ IdentifyContact()

void AirshipDotNet.IAirship.IdentifyContact ( string namedUserId )

Sets the named user ID.

The named user ID.

Implemented in AirshipDotNet.Airship, and AirshipDotNet.Airship.

◆ InboxMessages()

void AirshipDotNet.IAirship.InboxMessages ( Action< List< MessageCenter.Message > > messages )

Get the list of messages contained in the messages center.

The list of message.

Implemented in AirshipDotNet.Airship, and AirshipDotNet.Airship.

◆ IsAnyFeatureEnabled()

bool AirshipDotNet.IAirship.IsAnyFeatureEnabled ( )

Indicates whether any feature is enabled.

true if any feature is enabled; otherwise, false.

Implemented in AirshipDotNet.Airship, and AirshipDotNet.Airship.

◆ IsFeatureEnabled()

bool AirshipDotNet.IAirship.IsFeatureEnabled ( Features feature )

Indicates whether particular features are enabled.

Parameters

features The features.

true if the features are enabled; otherwise, false.

Implemented in AirshipDotNet.Airship, and AirshipDotNet.Airship.

◆ MarkMessageRead()

void AirshipDotNet.IAirship.MarkMessageRead ( string messageId )

Mark a specific message as read.

Parameters

messageId The identifier for the message to mark as read.

Implemented in AirshipDotNet.Airship, and AirshipDotNet.Airship.

◆ MessageCenterCount()

void AirshipDotNet.IAirship.MessageCenterCount ( Action< int > messageCount )

Get the total count of message center messages.

The message center count.

Implemented in AirshipDotNet.Airship, and AirshipDotNet.Airship.

◆ MessageCenterUnreadCount()

void AirshipDotNet.IAirship.MessageCenterUnreadCount ( Action< int > unreadMessageCount )

Get the message center unread count.

The message center unread count.

Implemented in AirshipDotNet.Airship, and AirshipDotNet.Airship.

◆ ResetContact()

void AirshipDotNet.IAirship.ResetContact ( )

Reset Contacts.

Implemented in AirshipDotNet.Airship, and AirshipDotNet.Airship.

◆ TrackScreen()

void AirshipDotNet.IAirship.TrackScreen ( string screen )

track a screen for a specific app screen

Parameters

screen The screen's identifier. to add.

Implemented in AirshipDotNet.Airship, and AirshipDotNet.Airship.

Property Documentation

◆ ChannelId

string AirshipDotNet.IAirship.ChannelId

get

Get the channel ID for the device.

The channel identifier.

Implemented in AirshipDotNet.Airship.

◆ EnabledFeatures

Features AirshipDotNet.IAirship.EnabledFeatures

getset

Currently enabled features.

The currently enabled features

Implemented in AirshipDotNet.Airship.

◆ InAppAutomationDisplayInterval

TimeSpan AirshipDotNet.IAirship.InAppAutomationDisplayInterval

getset

Gets or sets the In-App Automation display interval.

The display interval.

Implemented in AirshipDotNet.Airship.

◆ InAppAutomationPaused

bool AirshipDotNet.IAirship.InAppAutomationPaused

getset

Gets or sets whether In-App Automation is paused.

Whether In-App Automation is paused.

Implemented in AirshipDotNet.Airship.

◆ Tags

IEnumerable<string> AirshipDotNet.IAirship.Tags

get

Gets the tags currently set for the device.

The tags.

Implemented in AirshipDotNet.Airship.

◆ UserNotificationsEnabled

bool AirshipDotNet.IAirship.UserNotificationsEnabled

getset

Indicates whether user notifications are enabled.

true if notifications are enabled; otherwise, false.

Implemented in AirshipDotNet.Airship.

Event Documentation

◆ OnChannelCreation

EventHandler<ChannelEventArgs> AirshipDotNet.IAirship.OnChannelCreation

Add/remove the channel creation event listener.

The channel creation event listener.

◆ OnDeepLinkReceived

EventHandler<DeepLinkEventArgs> AirshipDotNet.IAirship.OnDeepLinkReceived

Add/remove the deep link event listener.

The deep link event listener.

Implemented in AirshipDotNet.Airship.

◆ OnMessageCenterDisplay

EventHandler<MessageCenterEventArgs> AirshipDotNet.IAirship.OnMessageCenterDisplay

Add/remove the message center display event listener.

The message center display listener.

Implemented in AirshipDotNet.Airship.

◆ OnMessageCenterUpdated

EventHandler AirshipDotNet.IAirship.OnMessageCenterUpdated

Add/remove the Inbox updated event listener.

The Inbox updated listener.

◆ OnPushNotificationStatusUpdate

EventHandler<PushNotificationStatusEventArgs> AirshipDotNet.IAirship.OnPushNotificationStatusUpdate

Add/remove the push notification status listener.

Public Member Functions

Properties

Events

Detailed Description

Member Function Documentation

◆ AddCustomEvent()

◆ AssociateIdentifier()

◆ DeleteMessage()

◆ DisableFeatures()

◆ DisplayMessage()

◆ DisplayMessageCenter()

◆ EditChannelAttributes()

◆ EditChannelSubscriptionLists()

◆ EditChannelTagGroups()

◆ EditContactAttributes()

◆ EditContactSubscriptionLists()

◆ EditContactTagGroups()

◆ EditDeviceTags()

◆ EnableFeatures()

◆ GetNamedUser()

◆ IdentifyContact()

◆ InboxMessages()

◆ IsAnyFeatureEnabled()

◆ IsFeatureEnabled()

◆ MarkMessageRead()

◆ MessageCenterCount()

◆ MessageCenterUnreadCount()

◆ ResetContact()

◆ TrackScreen()

Property Documentation

◆ ChannelId

◆ EnabledFeatures

◆ InAppAutomationDisplayInterval

◆ InAppAutomationPaused

◆ Tags

◆ UserNotificationsEnabled

Event Documentation

◆ OnChannelCreation

◆ OnDeepLinkReceived

◆ OnMessageCenterDisplay

◆ OnMessageCenterUpdated

◆ OnPushNotificationStatusUpdate