The primary manager class for the Urban Airship plugin. More...

Collaboration diagram for UrbanAirship.UAirship:

Public Member Functions
delegate void	PushReceivedEventHandler (PushMessage message)
	Push received event handler.

delegate void	PushOpenedEventHandler (PushMessage message)
	Push opened event handler.

delegate void	DeepLinkReceivedEventHandler (string deeplink)
	Deep link received event handler.

delegate void	ChannelUpdateEventHandler (string channelId)
	Channel update event handler.

delegate void	InboxUpdatedEventHandler (uint messageUnreadCount, uint messageCount)
	Inbox update event handler.

delegate void	ShowInboxEventHandler (string messageId)
	Show inbox event handler.

string	GetDeepLink (bool clear=true)
	Gets the last received deep link.

PushMessage	GetIncomingPush (bool clear=true)
	Gets the last stored incoming push message.

void	AddTag (string tag)
	Adds the provided device tag.

void	RemoveTag (string tag)
	Removes the provided device tag.

void	AddCustomEvent (CustomEvent customEvent)
	Adds a custom event.

void	TrackScreen (string screenName)
	Adds a screen tracking event to analytics.

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

void	DisplayMessageCenter ()
	Displays the message center.

void	DisplayInboxMessage (string messageId)
	Displays an inbox message.

void	RefreshInbox ()
	Refreshes the inbox.

IEnumerable< InboxMessage >	InboxMessages ()
	Gets the inbox messages.

void	MarkInboxMessageRead (string messageId)
	Mark an inbox message as having been read.

void	DeleteInboxMessage (string messageId)
	Delete an inbox message.

void	SetAutoLaunchDefaultMessageCenter (bool enabled)
	Sets the default behavior when the message center is launched from a push notification.

TagGroupEditor	EditNamedUserTagGroups ()
	Returns an editor for named user tag groups.

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

AttributeEditor	EditChannelAttributes ()
	Returns an editor for channel attributes.

AttributeEditor	EditNamedUserAttributes ()
	Returns an editor for named user attributes.

void	OpenPreferenceCenter (string preferenceCenterId)
	Opens the Preference Center with the specified ID.

void	SetEnabledFeatures (string[] enabledFeatures)
	Sets the enabled SDK features.

void	EnableFeatures (string[] enabledFeatures)
	Enables the specified SDK features.

void	DisableFeatures (string[] disabledFeatures)
	Disables the specified SDK features.

bool	IsFeatureEnabled (string[] features)
	Returns a boolean if the specified SDK features are enabled.

bool	IsAnyFeatureEnabled (string[] features)
	Returns a boolean if any of the specified SDK feature are enabled.

string[]	GetEnabledFeatures ()
	Gets the enabled SDK features.

Properties
static UAirship	Shared `[get]`
	Gets the shared UAirship instance.

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

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

string	ChannelId `[get]`
	Gets the channel identifier associated with the device.

string	NamedUserId `[get, set]`
	Gets or sets the named user identifier.

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

bool	InAppAutomationPaused `[get, set]`
	Pauses/resumes In-App automation.

int	MessageCenterUnreadCount `[get]`
	Gets the number of unread messages for the message center.

int	MessageCenterCount `[get]`
	Gets the number of messages for the message center.

Events
PushReceivedEventHandler	OnPushReceived
	Occurs when a push is received.

PushOpenedEventHandler	OnPushOpened
	Occurs when a push is opened.

DeepLinkReceivedEventHandler	OnDeepLinkReceived
	Occurs when a deep link is received.

ChannelUpdateEventHandler	OnChannelUpdated
	Occurs when the channel updates.

InboxUpdatedEventHandler	OnInboxUpdated
	Occurs when the inbox updates.

ShowInboxEventHandler	OnShowInbox
	Occurs when the app needs to show the inbox.

Detailed Description

The primary manager class for the Urban Airship plugin.

Member Function Documentation

◆ AddCustomEvent()

void UrbanAirship.UAirship.AddCustomEvent ( CustomEvent customEvent )

inline

Adds a custom event.

Parameters

customEvent The custom event.

◆ AddTag()

void UrbanAirship.UAirship.AddTag ( string tag )

inline

Adds the provided device tag.

Parameters

tag The tag.

◆ AssociateIdentifier()

void UrbanAirship.UAirship.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.

◆ ChannelUpdateEventHandler()

delegate void UrbanAirship.UAirship.ChannelUpdateEventHandler ( string channelId )

Channel update event handler.

◆ DeepLinkReceivedEventHandler()

delegate void UrbanAirship.UAirship.DeepLinkReceivedEventHandler ( string deeplink )

Deep link received event handler.

◆ DeleteInboxMessage()

void UrbanAirship.UAirship.DeleteInboxMessage ( string messageId )

inline

Delete an inbox message.

Parameters

messageId The messageId for the message.

◆ DisableFeatures()

void UrbanAirship.UAirship.DisableFeatures ( string[] disabledFeatures )

inline

Disables the specified SDK features.

Parameters

disabledFeatures The features to disable

◆ DisplayInboxMessage()

void UrbanAirship.UAirship.DisplayInboxMessage ( string messageId )

inline

Displays an inbox message.

Parameters

messageId The messageId for the message.

◆ DisplayMessageCenter()

void UrbanAirship.UAirship.DisplayMessageCenter ( )

inline

Displays the message center.

◆ EditChannelAttributes()

AttributeEditor UrbanAirship.UAirship.EditChannelAttributes ( )

inline

Returns an editor for channel attributes.

Returns: A AttributeEditor for channel attributes.

◆ EditChannelTagGroups()

TagGroupEditor UrbanAirship.UAirship.EditChannelTagGroups ( )

inline

Returns an editor for channel tag groups.

Returns: A TagGroupEditor for channel tag groups.

◆ EditNamedUserAttributes()

AttributeEditor UrbanAirship.UAirship.EditNamedUserAttributes ( )

inline

Returns an editor for named user attributes.

Returns: A AttributeEditor for named user attributes.

◆ EditNamedUserTagGroups()

TagGroupEditor UrbanAirship.UAirship.EditNamedUserTagGroups ( )

inline

Returns an editor for named user tag groups.

Returns: A TagGroupEditor for named user tag groups.

◆ EnableFeatures()

void UrbanAirship.UAirship.EnableFeatures ( string[] enabledFeatures )

inline

Enables the specified SDK features.

Parameters

enabledFeatures The features to enable

◆ GetDeepLink()

string UrbanAirship.UAirship.GetDeepLink ( bool clear = true )

inline

Gets the last received deep link.

Returns: The deep link.

Parameters

clear If set to true clear the stored deep link after accessing it.

◆ GetEnabledFeatures()

string[] UrbanAirship.UAirship.GetEnabledFeatures ( )

inline

Gets the enabled SDK features.

The features enabled

◆ GetIncomingPush()

PushMessage UrbanAirship.UAirship.GetIncomingPush ( bool clear = true )

inline

Gets the last stored incoming push message.

Returns: The push message.

Parameters

clear If set to true clear the stored push message after accessing it.

◆ InboxMessages()

IEnumerable< InboxMessage > UrbanAirship.UAirship.InboxMessages ( )

inline

Gets the inbox messages.

An enumberable list of InboxMessage objects.

◆ InboxUpdatedEventHandler()

delegate void UrbanAirship.UAirship.InboxUpdatedEventHandler	(	uint	messageUnreadCount,
		uint	messageCount
	)

Inbox update event handler.

◆ IsAnyFeatureEnabled()

bool UrbanAirship.UAirship.IsAnyFeatureEnabled ( string[] features )

inline

Returns a boolean if any of the specified SDK feature are enabled.

Parameters

features The features to check

true if any of these features is enabled, otherwise false

◆ IsFeatureEnabled()

bool UrbanAirship.UAirship.IsFeatureEnabled ( string[] features )

inline

Returns a boolean if the specified SDK features are enabled.

Parameters

features The features to check

true if feature is enabled, otherwise false

◆ MarkInboxMessageRead()

void UrbanAirship.UAirship.MarkInboxMessageRead ( string messageId )

inline

Mark an inbox message as having been read.

Parameters

messageId The messageId for the message.

◆ OpenPreferenceCenter()

void UrbanAirship.UAirship.OpenPreferenceCenter ( string preferenceCenterId )

inline

Opens the Preference Center with the specified ID.

Parameters

preferenceCenterId The Preference Center's ID

◆ PushOpenedEventHandler()

delegate void UrbanAirship.UAirship.PushOpenedEventHandler ( PushMessage message )

Push opened event handler.

◆ PushReceivedEventHandler()

delegate void UrbanAirship.UAirship.PushReceivedEventHandler ( PushMessage message )

Push received event handler.

◆ RefreshInbox()

void UrbanAirship.UAirship.RefreshInbox ( )

inline

Refreshes the inbox.

◆ RemoveTag()

void UrbanAirship.UAirship.RemoveTag ( string tag )

inline

Removes the provided device tag.

Parameters

tag The tag.

◆ SetAutoLaunchDefaultMessageCenter()

void UrbanAirship.UAirship.SetAutoLaunchDefaultMessageCenter ( bool enabled )

inline

Sets the default behavior when the message center is launched from a push notification.

Parameters

enabled true to automatically launch the default message center. If false the message center must be manually launched by the app.

◆ SetEnabledFeatures()

void UrbanAirship.UAirship.SetEnabledFeatures ( string[] enabledFeatures )

inline

Sets the enabled SDK features.

Parameters

enabledFeatures The features to enable

◆ ShowInboxEventHandler()

delegate void UrbanAirship.UAirship.ShowInboxEventHandler ( string messageId )

Show inbox event handler.

◆ TrackScreen()

void UrbanAirship.UAirship.TrackScreen ( string screenName )

inline

Adds a screen tracking event to analytics.

Parameters

screenName The screen name.

Property Documentation

◆ ChannelId

string UrbanAirship.UAirship.ChannelId

get

Gets the channel identifier associated with the device.

The channel identifier.

◆ InAppAutomationDisplayInterval

TimeSpan UrbanAirship.UAirship.InAppAutomationDisplayInterval

getset

Gets or sets the In-App automation display interval.

The display interval.

◆ InAppAutomationPaused

bool UrbanAirship.UAirship.InAppAutomationPaused

getset

Pauses/resumes In-App automation.

true if paused, otherwise false

◆ MessageCenterCount

int UrbanAirship.UAirship.MessageCenterCount

get

Gets the number of messages for the message center.

◆ MessageCenterUnreadCount

int UrbanAirship.UAirship.MessageCenterUnreadCount

get

Gets the number of unread messages for the message center.

◆ NamedUserId

string UrbanAirship.UAirship.NamedUserId

getset

Gets or sets the named user identifier.

The named user identifier.

◆ Shared

UAirship UrbanAirship.UAirship.Shared

staticget

Gets the shared UAirship instance.

The shared UAirship instance.

◆ Tags

IEnumerable<string> UrbanAirship.UAirship.Tags

get

Gets the tags currently set for the device.

The tags.

◆ UserNotificationsEnabled

bool UrbanAirship.UAirship.UserNotificationsEnabled

getset

Determines whether user notifications are enabled.

true if user notifications are enabled; otherwise, false.

Event Documentation

◆ OnChannelUpdated

ChannelUpdateEventHandler UrbanAirship.UAirship.OnChannelUpdated

Occurs when the channel updates.

◆ OnDeepLinkReceived

DeepLinkReceivedEventHandler UrbanAirship.UAirship.OnDeepLinkReceived

Occurs when a deep link is received.

◆ OnInboxUpdated

InboxUpdatedEventHandler UrbanAirship.UAirship.OnInboxUpdated

Occurs when the inbox updates.

◆ OnPushOpened

PushOpenedEventHandler UrbanAirship.UAirship.OnPushOpened

Occurs when a push is opened.

◆ OnPushReceived

PushReceivedEventHandler UrbanAirship.UAirship.OnPushReceived

Occurs when a push is received.

◆ OnShowInbox

ShowInboxEventHandler UrbanAirship.UAirship.OnShowInbox

Occurs when the app needs to show the inbox.