Inherits IAirship.
Public Member Functions | |
void | EnableFeatures (Features features) |
Enables particular features. | |
void | DisableFeatures (Features features) |
Disables particular features. | |
bool | IsFeatureEnabled (Features features) |
Indicates whether particular features are enabled. | |
bool | IsAnyFeatureEnabled () |
Indicates whether any feature is enabled. | |
void | GetNamedUser (Action< string > namedUser) |
Gets the named user. | |
void | ResetContact () |
Reset the named user. | |
void | IdentifyContact (string namedUserId) |
Identifiy the named user. | |
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 > count) |
Get the message center unread count. | |
void | MessageCenterCount (Action< int > count) |
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. | |
Attributes.AttributeEditor | EditAttributes () |
Edit channel attributes. | |
Attributes.AttributeEditor | EditChannelAttributes () |
Edit channel attributes. | |
Attributes.AttributeEditor | EditContactAttributes () |
Edit named user attributes. | |
Channel.TagGroupsEditor | EditContactTagGroups () |
Returns an editor for named user tag groups. | |
Channel.TagGroupsEditor | EditChannelTagGroups () |
Returns an editor for channel tag groups. | |
Channel.SubscriptionListEditor | EditChannelSubscriptionLists () |
Returns an editor for channel subscription lists. | |
Contact.SubscriptionListEditor | EditContactSubscriptionLists () |
Returns an editor for contact subscription lists. | |
Properties | |
static Airship | Instance [get] |
Gets the shared UAirship instance. | |
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. | |
EventHandler< DeepLinkEventArgs > | OnDeepLinkReceived |
Add/remove the deep link event listener. | |
EventHandler | OnMessageCenterUpdated |
Add/remove the Inbox updated event listener. | |
EventHandler< MessageCenterEventArgs > | OnMessageCenterDisplay |
Add/remove the message center display event listener. | |
EventHandler< ChannelEventArgs > | OnChannelCreation |
Add/remove the channel creation event listener. | |
EventHandler< PushNotificationStatusEventArgs > | OnPushNotificationStatusUpdate |
Add/remote the push notification status listener. | |
bool | InAppAutomationEnabled [get, set] |
Gets or sets whether In-App Automation is enabled. | |
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. | |
Member Function Documentation
◆ AddCustomEvent()
|
inline |
Add a custom event.
- Parameters
-
customEvent The CustomEvent to add.
◆ AssociateIdentifier()
|
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.
◆ DeleteMessage()
|
inline |
Delete a specific message.
- Parameters
-
messageId The identifier for the message to delete.
◆ DisableFeatures()
|
inline |
Disables particular features.
- Parameters
-
features The features.
◆ DisplayMessage()
|
inline |
Displays a specific message.
- Parameters
-
messageId The identifier for the message to display.
◆ DisplayMessageCenter()
|
inline |
Displays the message center.
◆ EditAttributes()
|
inline |
Edit channel attributes.
Deprecated : use EditChannelAttributes() instead.
- Returns
- An AttributeEditor for channel attributes.
◆ EditChannelAttributes()
|
inline |
Edit channel attributes.
- Returns
- An AttributeEditor for channel attributes.
◆ EditChannelSubscriptionLists()
|
inline |
Returns an editor for channel subscription lists.
- Returns
- A SubscriptionListEditor for channel subscription lists.
◆ EditChannelTagGroups()
|
inline |
Returns an editor for channel tag groups.
- Returns
- A TagGroupsEditor for channel tag groups.
◆ EditContactAttributes()
|
inline |
Edit named user attributes.
- Returns
- An AttributeEditor for named user attributes.
◆ EditContactSubscriptionLists()
|
inline |
Returns an editor for contact subscription lists.
- Returns
- A SubscriptionListEditor for channel subscription lists.
◆ EditContactTagGroups()
|
inline |
Returns an editor for named user tag groups.
- Returns
- A TagGroupsEditor for named user tag groups.
◆ EditDeviceTags()
|
inline |
Edit the device tags.
- Returns
- A TagEditor for editing device tags.
◆ EnableFeatures()
|
inline |
Enables particular features.
- Parameters
-
features The features.
◆ GetNamedUser()
|
inline |
Gets the named user.
Returns the named user.
◆ IdentifyContact()
|
inline |
Identifiy the named user.
◆ InboxMessages()
|
inline |
Get the list of messages contained in the messages center.
The list of message.
◆ IsAnyFeatureEnabled()
|
inline |
Indicates whether any feature is enabled.
true
if any feature is enabled; otherwise, false
.
◆ IsFeatureEnabled()
|
inline |
Indicates whether particular features are enabled.
- Parameters
-
features The features.
true
if the features are enabled; otherwise, false
.
◆ MarkMessageRead()
|
inline |
Mark a specific message as read.
- Parameters
-
messageId The identifier for the message to mark as read.
◆ MessageCenterCount()
|
inline |
Get the total count of message center messages.
Returns the message center count.
◆ MessageCenterUnreadCount()
|
inline |
Get the message center unread count.
Returns the message center unread count.
◆ ResetContact()
|
inline |
Reset the named user.
◆ TrackScreen()
|
inline |
track a screen for a specific app screen
- Parameters
-
screen The screen's identifier. to add.
Property Documentation
◆ ChannelId
|
get |
Get the channel ID for the device.
The channel identifier.
◆ EnabledFeatures
|
getset |
Currently enabled features.
The currently enabled features
◆ InAppAutomationDisplayInterval
|
getset |
Gets or sets the In-App Automation display interval.
The display interval.
◆ InAppAutomationEnabled
|
getset |
Gets or sets whether In-App Automation is enabled.
Whether In-App Automation is enabled.
◆ InAppAutomationPaused
|
getset |
Gets or sets whether In-App Automation is paused.
Whether In-App Automation is paused.
◆ Instance
|
staticget |
Gets the shared UAirship instance.
The shared UAirship instance.
◆ OnChannelCreation
|
addremove |
Add/remove the channel creation event listener.
The channel creation event listener.
◆ OnDeepLinkReceived
|
addremove |
Add/remove the deep link event listener.
The deep link event listener.
◆ OnMessageCenterDisplay
|
addremove |
Add/remove the message center display event listener.
The message center display listener.
◆ OnMessageCenterUpdated
|
addremove |
Add/remove the Inbox updated event listener.
The Inbox updated listener.
◆ OnPushNotificationStatusUpdate
|
addremove |
Add/remote the push notification status listener.
The push notification status update event listener.
◆ Tags
|
get |
Gets the tags currently set for the device.
The tags.
◆ UserNotificationsEnabled
|
getset |
Indicates whether user notifications are enabled.
true
if notifications are enabled; otherwise, false
.