Airship Unity Plugin 10.0.0
  • AirshipSDK
  • AirshipChannel
Public Member Functions | List of all members
AirshipSDK.AirshipChannel Class Reference

Airship channel. More...

Public Member Functions

string? GetChannelId ()
 Gets the channel ID associated with the device.
 
IEnumerator WaitForChannelId (Action< string > onComplete, Action< Exception > onError=null)
 Waits for the channel ID asynchronously using a coroutine.
 
IEnumerable< string > GetTags ()
 Gets the tags currently set for the device.
 
TagEditor EditTags ()
 Returns an editor for channel tags.
 
TagGroupEditor EditTagGroups ()
 Returns an editor for channel tag groups.
 
AttributeEditor EditAttributes ()
 Returns an editor for channel attributes.
 
IEnumerator GetSubscriptionLists (Action< IEnumerable< string > > onComplete, Action< Exception > onError=null)
 Gets the channel's subscription lists asynchronously using a coroutine.
 
SubscriptionListEditor EditSubscriptionLists ()
 Returns an editor for channel subscription lists.
 

Detailed Description

Airship channel.

Member Function Documentation

◆ EditAttributes()

AttributeEditor AirshipSDK.AirshipChannel.EditAttributes ( )
inline

Returns an editor for channel attributes.

Returns
A AttributeEditor for channel attributes.

◆ EditSubscriptionLists()

SubscriptionListEditor AirshipSDK.AirshipChannel.EditSubscriptionLists ( )
inline

Returns an editor for channel subscription lists.

Returns
A SubscriptionListEditor.

◆ EditTagGroups()

TagGroupEditor AirshipSDK.AirshipChannel.EditTagGroups ( )
inline

Returns an editor for channel tag groups.

Returns
A TagGroupEditor for channel tag groups.

◆ EditTags()

TagEditor AirshipSDK.AirshipChannel.EditTags ( )
inline

Returns an editor for channel tags.

Returns
A TagEditor for channel tags.

◆ GetChannelId()

string? AirshipSDK.AirshipChannel.GetChannelId ( )
inline

Gets the channel ID associated with the device.

Returns
The channel ID.

◆ GetSubscriptionLists()

IEnumerator AirshipSDK.AirshipChannel.GetSubscriptionLists ( Action< IEnumerable< string > >  onComplete,
Action< Exception >  onError = null 
)
inline

Gets the channel's subscription lists asynchronously using a coroutine.

This method does not block Unity's main thread.

Parameters
onCompleteCallback invoked with the subscription lists when the operation completes.
onErrorOptional callback invoked if an error occurs.
Returns
A coroutine that can be started with StartCoroutine.

◆ GetTags()

IEnumerable< string > AirshipSDK.AirshipChannel.GetTags ( )
inline

Gets the tags currently set for the device.

Returns
The tags.

◆ WaitForChannelId()

IEnumerator AirshipSDK.AirshipChannel.WaitForChannelId ( Action< string >  onComplete,
Action< Exception >  onError = null 
)
inline

Waits for the channel ID asynchronously using a coroutine.

If the channel ID is not yet created, this method will wait for it before completing. After the channel ID is created, this method functions the same as getChannelId(). This method does not block Unity's main thread.

Parameters
onCompleteCallback invoked with the channel ID when the operation completes.
onErrorOptional callback invoked if an error occurs.
Returns
A coroutine that can be started with StartCoroutine.

Generated on Wed Sep 2 2026 21:27:03 for Airship Unity Plugin by   doxygen 1.9.8