Provides cross-platform access to a common subset of functionality between the iOS and Android SDKs. More...

Inheritance diagram for AirshipDotNet.Airship:

Collaboration diagram for AirshipDotNet.Airship:

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.

Channel.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 > messageCount)
	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 > > listMessages)
	Get the list of messages contained in the messages center.

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

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

AttributeEditor	EditAttributes ()

AttributeEditor	EditChannelAttributes ()
	Edit channel attributes.

AttributeEditor	EditContactAttributes ()
	Edit contact attributes.

ChannelSubscriptionListEditor	EditChannelSubscriptionLists ()
	Edit channel subscription lists.

ContactSubscriptionListEditor	EditContactSubscriptionLists ()
	Edit contact subscription list.

bool	OnDeepLink (string deepLink)

bool	OnShowMessageCenter (string? messageId)

void	OnInboxUpdated ()

void	OnChannelCreated (string channelId)

void	OnChange (PushNotificationStatus status)

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.

Channel.TagEditor	EditDeviceTags ()
	Edit the device tags.

void	AddCustomEvent (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 > messageCount)
	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 > > listMessages)
	Get the list of messages contained in the messages center.

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

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

AttributeEditor	EditAttributes ()

AttributeEditor	EditChannelAttributes ()
	Edit channel attributes.

AttributeEditor	EditContactAttributes ()
	Edit contact attributes.

Channel.SubscriptionListEditor	EditChannelSubscriptionLists ()
	Edit channel subscription lists.

Contact.SubscriptionListEditor	EditContactSubscriptionLists ()
	Edit contact subscription list.

override void	ReceivedDeepLink (NSUrl url, Action completionHandler)

void	OnDisplayMessageCenter (string messageID)

void	OnDisplayMessageCenter ()

void	OnDismissMessageCenter ()

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

EventHandler< MessageCenterEventArgs >	OnMessageCenterDisplay
	Add/remove the Message Center display listener.

static Airship	Instance `[get]`

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	InAppAutomationEnabled `[get, set]`

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.

Properties inherited from AirshipDotNet.IAirship

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

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

EventHandler?	OnMessageCenterUpdated
	Add/remove the Message Center updated listener.

Events inherited from AirshipDotNet.IAirship
EventHandler< ChannelEventArgs >	OnChannelCreation
	Add/remove the channel creation event listener.

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

EventHandler	OnMessageCenterUpdated
	Add/remove the Inbox updated event listener.

Detailed Description

Provides cross-platform access to a common subset of functionality between the iOS and Android SDKs.

Member Function Documentation

◆ AddCustomEvent() [1/2]

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

inline

Add a custom event.

Parameters

customEvent The CustomEvent to add.

Implements AirshipDotNet.IAirship.

◆ AddCustomEvent() [2/2]

void AirshipDotNet.Airship.AddCustomEvent ( CustomEvent customEvent )

inline

Add a custom event.

Parameters

customEvent The CustomEvent to add.

Implements AirshipDotNet.IAirship.

◆ AssociateIdentifier() [1/2]

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

inline

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.

Implements AirshipDotNet.IAirship.

◆ AssociateIdentifier() [2/2]

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

inline

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.

Implements AirshipDotNet.IAirship.

◆ DeleteMessage() [1/2]

void AirshipDotNet.Airship.DeleteMessage ( string messageId )

Delete a specific message.

Parameters

messageId The identifier for the message to delete.

Implements AirshipDotNet.IAirship.

◆ DeleteMessage() [2/2]

void AirshipDotNet.Airship.DeleteMessage ( string messageId )

inline

Delete a specific message.

Parameters

messageId The identifier for the message to delete.

Implements AirshipDotNet.IAirship.

◆ DisableFeatures() [1/2]

void AirshipDotNet.Airship.DisableFeatures ( Features features )

Disables particular features.

Parameters

features The features.

Implements AirshipDotNet.IAirship.

◆ DisableFeatures() [2/2]

void AirshipDotNet.Airship.DisableFeatures ( Features features )

Disables particular features.

Parameters

features The features.

Implements AirshipDotNet.IAirship.

◆ DisplayMessage() [1/2]

void AirshipDotNet.Airship.DisplayMessage ( string messageId )

Displays a specific message.

Parameters

messageId The identifier for the message to display.

Implements AirshipDotNet.IAirship.

◆ DisplayMessage() [2/2]

void AirshipDotNet.Airship.DisplayMessage ( string messageId )

Displays a specific message.

Parameters

messageId The identifier for the message to display.

Implements AirshipDotNet.IAirship.

◆ DisplayMessageCenter() [1/2]

void AirshipDotNet.Airship.DisplayMessageCenter ( )

Displays the message center.

Implements AirshipDotNet.IAirship.

◆ DisplayMessageCenter() [2/2]

void AirshipDotNet.Airship.DisplayMessageCenter ( )

Displays the message center.

Implements AirshipDotNet.IAirship.

◆ EditAttributes() [1/2]

AttributeEditor AirshipDotNet.Airship.EditAttributes ( )

◆ EditAttributes() [2/2]

AttributeEditor AirshipDotNet.Airship.EditAttributes ( )

◆ EditChannelAttributes() [1/2]

AttributeEditor AirshipDotNet.Airship.EditChannelAttributes ( )

Edit channel attributes.

Returns: An AttributeEditor for channel attributes.

Implements AirshipDotNet.IAirship.

◆ EditChannelAttributes() [2/2]

AttributeEditor AirshipDotNet.Airship.EditChannelAttributes ( )

inline

Edit channel attributes.

Returns: An AttributeEditor for channel attributes.

Implements AirshipDotNet.IAirship.

◆ EditChannelSubscriptionLists() [1/2]

ChannelSubscriptionListEditor AirshipDotNet.Airship.EditChannelSubscriptionLists ( )

inline

Edit channel subscription lists.

Returns: An SubscriptionListsEditor for channel subscription lists.

Implements AirshipDotNet.IAirship.

◆ EditChannelSubscriptionLists() [2/2]

Channel.SubscriptionListEditor AirshipDotNet.Airship.EditChannelSubscriptionLists ( )

inline

Edit channel subscription lists.

Returns: An SubscriptionListsEditor for channel subscription lists.

Implements AirshipDotNet.IAirship.

◆ EditChannelTagGroups() [1/2]

Channel.TagGroupsEditor AirshipDotNet.Airship.EditChannelTagGroups ( )

inline

Returns an editor for channel tag groups.

Returns: A TagGroupsEditor for channel tag groups.

Implements AirshipDotNet.IAirship.

◆ EditChannelTagGroups() [2/2]

Channel.TagGroupsEditor AirshipDotNet.Airship.EditChannelTagGroups ( )

inline

Returns an editor for channel tag groups.

Returns: A TagGroupsEditor for channel tag groups.

Implements AirshipDotNet.IAirship.

◆ EditContactAttributes() [1/2]

AttributeEditor AirshipDotNet.Airship.EditContactAttributes ( )

Edit contact attributes.

Returns: An AttributeEditor for contact attributes.

Implements AirshipDotNet.IAirship.

◆ EditContactAttributes() [2/2]

AttributeEditor AirshipDotNet.Airship.EditContactAttributes ( )

inline

Edit contact attributes.

Returns: An AttributeEditor for contact attributes.

Implements AirshipDotNet.IAirship.

◆ EditContactSubscriptionLists() [1/2]

ContactSubscriptionListEditor AirshipDotNet.Airship.EditContactSubscriptionLists ( )

inline

Edit contact subscription list.

Returns: An SubscriptionListsEditor for contact subscription lists.

Implements AirshipDotNet.IAirship.

◆ EditContactSubscriptionLists() [2/2]

Contact.SubscriptionListEditor AirshipDotNet.Airship.EditContactSubscriptionLists ( )

inline

Edit contact subscription list.

Returns: An SubscriptionListsEditor for contact subscription lists.

Implements AirshipDotNet.IAirship.

◆ EditContactTagGroups() [1/2]

Channel.TagGroupsEditor AirshipDotNet.Airship.EditContactTagGroups ( )

inline

Returns an editor for named user tag groups.

Returns: A TagGroupsEditor for named user tag groups.

Implements AirshipDotNet.IAirship.

◆ EditContactTagGroups() [2/2]

Channel.TagGroupsEditor AirshipDotNet.Airship.EditContactTagGroups ( )

inline

Returns an editor for named user tag groups.

Returns: A TagGroupsEditor for named user tag groups.

Implements AirshipDotNet.IAirship.

◆ EditDeviceTags() [1/2]

Channel.TagEditor AirshipDotNet.Airship.EditDeviceTags ( )

inline

Edit the device tags.

Returns: A TagEditor for editing device tags.

Implements AirshipDotNet.IAirship.

◆ EditDeviceTags() [2/2]

Channel.TagEditor AirshipDotNet.Airship.EditDeviceTags ( )

Edit the device tags.

Returns: A TagEditor for editing device tags.

Implements AirshipDotNet.IAirship.

◆ EnableFeatures() [1/2]

void AirshipDotNet.Airship.EnableFeatures ( Features features )

Enables particular features.

Parameters

features The features.

Implements AirshipDotNet.IAirship.

◆ EnableFeatures() [2/2]

void AirshipDotNet.Airship.EnableFeatures ( Features features )

Enables particular features.

Parameters

features The features.

Implements AirshipDotNet.IAirship.

◆ GetNamedUser() [1/2]

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

Gets the named user ID.

The named user ID.

Implements AirshipDotNet.IAirship.

◆ GetNamedUser() [2/2]

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

inline

Gets the named user ID.

The named user ID.

Implements AirshipDotNet.IAirship.

◆ IdentifyContact() [1/2]

void AirshipDotNet.Airship.IdentifyContact ( string namedUserId )

Sets the named user ID.

The named user ID.

Implements AirshipDotNet.IAirship.

◆ IdentifyContact() [2/2]

void AirshipDotNet.Airship.IdentifyContact ( string namedUserId )

Sets the named user ID.

The named user ID.

Implements AirshipDotNet.IAirship.

◆ InboxMessages() [1/2]

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

inline

Get the list of messages contained in the messages center.

The list of message.

Implements AirshipDotNet.IAirship.

◆ InboxMessages() [2/2]

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

inline

Get the list of messages contained in the messages center.

The list of message.

Implements AirshipDotNet.IAirship.

◆ IsAnyFeatureEnabled() [1/2]

bool AirshipDotNet.Airship.IsAnyFeatureEnabled ( )

Indicates whether any feature is enabled.

true if any feature is enabled; otherwise, false.

Implements AirshipDotNet.IAirship.

◆ IsAnyFeatureEnabled() [2/2]

bool AirshipDotNet.Airship.IsAnyFeatureEnabled ( )

Indicates whether any feature is enabled.

true if any feature is enabled; otherwise, false.

Implements AirshipDotNet.IAirship.

◆ IsFeatureEnabled() [1/2]

bool AirshipDotNet.Airship.IsFeatureEnabled ( Features feature )

Indicates whether particular features are enabled.

Parameters

features The features.

true if the features are enabled; otherwise, false.

Implements AirshipDotNet.IAirship.

◆ IsFeatureEnabled() [2/2]

bool AirshipDotNet.Airship.IsFeatureEnabled ( Features feature )

Indicates whether particular features are enabled.

Parameters

features The features.

true if the features are enabled; otherwise, false.

Implements AirshipDotNet.IAirship.

◆ MarkMessageRead() [1/2]

void AirshipDotNet.Airship.MarkMessageRead ( string messageId )

Mark a specific message as read.

Parameters

messageId The identifier for the message to mark as read.

Implements AirshipDotNet.IAirship.

◆ MarkMessageRead() [2/2]

void AirshipDotNet.Airship.MarkMessageRead ( string messageId )

inline

Mark a specific message as read.

Parameters

messageId The identifier for the message to mark as read.

Implements AirshipDotNet.IAirship.

◆ MessageCenterCount() [1/2]

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

Get the total count of message center messages.

The message center count.

Implements AirshipDotNet.IAirship.

◆ MessageCenterCount() [2/2]

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

inline

Get the total count of message center messages.

The message center count.

Implements AirshipDotNet.IAirship.

◆ MessageCenterUnreadCount() [1/2]

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

Get the message center unread count.

The message center unread count.

Implements AirshipDotNet.IAirship.

◆ MessageCenterUnreadCount() [2/2]

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

inline

Get the message center unread count.

The message center unread count.

Implements AirshipDotNet.IAirship.

◆ OnChange()

void AirshipDotNet.Airship.OnChange ( PushNotificationStatus status )

◆ OnChannelCreated()

void AirshipDotNet.Airship.OnChannelCreated ( string channelId )

◆ OnDeepLink()

bool AirshipDotNet.Airship.OnDeepLink ( string deepLink )

inline

◆ OnDismissMessageCenter()

void AirshipDotNet.Airship.OnDismissMessageCenter ( )

inline

◆ OnDisplayMessageCenter() [1/2]

void AirshipDotNet.Airship.OnDisplayMessageCenter ( )

◆ OnDisplayMessageCenter() [2/2]

void AirshipDotNet.Airship.OnDisplayMessageCenter ( string messageID )

◆ OnInboxUpdated()

void AirshipDotNet.Airship.OnInboxUpdated ( )

◆ OnShowMessageCenter()

bool AirshipDotNet.Airship.OnShowMessageCenter ( string? messageId )

inline

◆ ReceivedDeepLink()

override void AirshipDotNet.Airship.ReceivedDeepLink	(	NSUrl	url,
		Action	completionHandler )

inline

◆ ResetContact() [1/2]

void AirshipDotNet.Airship.ResetContact ( )

Reset Contacts.

Implements AirshipDotNet.IAirship.

◆ ResetContact() [2/2]

void AirshipDotNet.Airship.ResetContact ( )

Reset Contacts.

Implements AirshipDotNet.IAirship.

◆ TrackScreen() [1/2]

void AirshipDotNet.Airship.TrackScreen ( string screen )

track a screen for a specific app screen

Parameters

screen The screen's identifier. to add.

Implements AirshipDotNet.IAirship.

◆ TrackScreen() [2/2]

void AirshipDotNet.Airship.TrackScreen ( string screen )

track a screen for a specific app screen

Parameters

screen The screen's identifier. to add.

Implements AirshipDotNet.IAirship.

Property Documentation

◆ ChannelId

string AirshipDotNet.Airship.ChannelId

get

Get the channel ID for the device.

The channel identifier.

Implements AirshipDotNet.IAirship.

◆ EnabledFeatures

Features AirshipDotNet.Airship.EnabledFeatures

getset

Currently enabled features.

The currently enabled features

Implements AirshipDotNet.IAirship.

◆ InAppAutomationDisplayInterval

TimeSpan AirshipDotNet.Airship.InAppAutomationDisplayInterval

getset

Gets or sets the In-App Automation display interval.

The display interval.

Implements AirshipDotNet.IAirship.

◆ InAppAutomationEnabled

bool AirshipDotNet.Airship.InAppAutomationEnabled

getset

◆ InAppAutomationPaused

bool AirshipDotNet.Airship.InAppAutomationPaused

getset

Gets or sets whether In-App Automation is paused.

Whether In-App Automation is paused.

Implements AirshipDotNet.IAirship.

◆ Instance

static Airship AirshipDotNet.Airship.Instance

staticget

◆ OnDeepLinkReceived

EventHandler< DeepLinkEventArgs > AirshipDotNet.Airship.OnDeepLinkReceived

addremove

Add/remove the deep link listener.

Implements AirshipDotNet.IAirship.

◆ OnMessageCenterDisplay

EventHandler< MessageCenterEventArgs > AirshipDotNet.Airship.OnMessageCenterDisplay

addremove

Add/remove the Message Center display listener.

Implements AirshipDotNet.IAirship.

◆ Tags

IEnumerable< string > AirshipDotNet.Airship.Tags

get

Gets the tags currently set for the device.

The tags.

Implements AirshipDotNet.IAirship.

◆ UserNotificationsEnabled

bool AirshipDotNet.Airship.UserNotificationsEnabled

getset

Indicates whether user notifications are enabled.

true if notifications are enabled; otherwise, false.

Implements AirshipDotNet.IAirship.

Event Documentation

◆ OnChannelCreation

EventHandler< ChannelEventArgs > AirshipDotNet.Airship.OnChannelCreation

Add/remove the channel creation listener.

◆ OnMessageCenterUpdated

EventHandler AirshipDotNet.Airship.OnMessageCenterUpdated

Add/remove the Message Center updated listener.

◆ OnPushNotificationStatusUpdate

EventHandler< PushNotificationStatusEventArgs > AirshipDotNet.Airship.OnPushNotificationStatusUpdate

Add/remove the push notification status listener.

Public Member Functions

Properties

Events

Detailed Description

Member Function Documentation

◆ AddCustomEvent() [1/2]

◆ AddCustomEvent() [2/2]

◆ AssociateIdentifier() [1/2]

◆ AssociateIdentifier() [2/2]

◆ DeleteMessage() [1/2]

◆ DeleteMessage() [2/2]

◆ DisableFeatures() [1/2]

◆ DisableFeatures() [2/2]

◆ DisplayMessage() [1/2]

◆ DisplayMessage() [2/2]

◆ DisplayMessageCenter() [1/2]

◆ DisplayMessageCenter() [2/2]

◆ EditAttributes() [1/2]

◆ EditAttributes() [2/2]

◆ EditChannelAttributes() [1/2]

◆ EditChannelAttributes() [2/2]

◆ EditChannelSubscriptionLists() [1/2]

◆ EditChannelSubscriptionLists() [2/2]

◆ EditChannelTagGroups() [1/2]

◆ EditChannelTagGroups() [2/2]

◆ EditContactAttributes() [1/2]

◆ EditContactAttributes() [2/2]

◆ EditContactSubscriptionLists() [1/2]

◆ EditContactSubscriptionLists() [2/2]

◆ EditContactTagGroups() [1/2]

◆ EditContactTagGroups() [2/2]

◆ EditDeviceTags() [1/2]

◆ EditDeviceTags() [2/2]

◆ EnableFeatures() [1/2]

◆ EnableFeatures() [2/2]

◆ GetNamedUser() [1/2]

◆ GetNamedUser() [2/2]

◆ IdentifyContact() [1/2]

◆ IdentifyContact() [2/2]

◆ InboxMessages() [1/2]

◆ InboxMessages() [2/2]

◆ IsAnyFeatureEnabled() [1/2]

◆ IsAnyFeatureEnabled() [2/2]

◆ IsFeatureEnabled() [1/2]

◆ IsFeatureEnabled() [2/2]

◆ MarkMessageRead() [1/2]

◆ MarkMessageRead() [2/2]

◆ MessageCenterCount() [1/2]

◆ MessageCenterCount() [2/2]

◆ MessageCenterUnreadCount() [1/2]

◆ MessageCenterUnreadCount() [2/2]

◆ OnChange()

◆ OnChannelCreated()

◆ OnDeepLink()

◆ OnDismissMessageCenter()

◆ OnDisplayMessageCenter() [1/2]

◆ OnDisplayMessageCenter() [2/2]

◆ OnInboxUpdated()

◆ OnShowMessageCenter()

◆ ReceivedDeepLink()

◆ ResetContact() [1/2]

◆ ResetContact() [2/2]

◆ TrackScreen() [1/2]

◆ TrackScreen() [2/2]

Property Documentation

◆ ChannelId

◆ EnabledFeatures

◆ InAppAutomationDisplayInterval

◆ InAppAutomationEnabled

◆ InAppAutomationPaused

◆ Instance

◆ OnDeepLinkReceived

◆ OnMessageCenterDisplay

◆ Tags

◆ UserNotificationsEnabled

Event Documentation

◆ OnChannelCreation

◆ OnMessageCenterUpdated

◆ OnPushNotificationStatusUpdate