Airship Live Activity manager. More...

Inheritance diagram for AirshipSDK.AirshipLiveActivityManager:

Collaboration diagram for AirshipSDK.AirshipLiveActivityManager:

Public Member Functions
IEnumerator	List (LiveActivityListRequest request, Action< LiveActivityInfo[]> onComplete, Action< Exception > onError=null)
	Lists Live Activities matching the given attributes type.

IEnumerator	ListAll (Action< LiveActivityInfo[]> onComplete, Action< Exception > onError=null)
	Lists all Live Activities.

IEnumerator	Start (LiveActivityStartRequest request, Action< LiveActivityInfo > onComplete, Action< Exception > onError=null)
	Starts a new Live Activity.

IEnumerator	Update (LiveActivityUpdateRequest request, Action onComplete=null, Action< Exception > onError=null)
	Updates a Live Activity.

IEnumerator	End (LiveActivityEndRequest request, Action onComplete=null, Action< Exception > onError=null)
	Ends a Live Activity.

Detailed Description

Airship Live Activity manager.

iOS only.

Member Function Documentation

◆ End()

IEnumerator AirshipSDK.AirshipLiveActivityManager.End	(	LiveActivityEndRequest	request,
		Action	onComplete = `null`,
		Action< Exception >	onError = `null`
	)

inline

Ends a Live Activity.

Parameters

request	The end request.
onComplete	Optional callback invoked when the operation completes.
onError	Optional callback invoked if an error occurs.

Returns: A coroutine that can be started with StartCoroutine.

Implements AirshipSDK.IAirshipLiveActivityManager.

◆ List()

IEnumerator AirshipSDK.AirshipLiveActivityManager.List	(	LiveActivityListRequest	request,
		Action< LiveActivityInfo[]>	onComplete,
		Action< Exception >	onError = `null`
	)

inline

Lists Live Activities matching the given attributes type.

Parameters

request	The list request containing the attributes type filter.
onComplete	Callback invoked with the matching Live Activities.
onError	Optional callback invoked if an error occurs.

Returns: A coroutine that can be started with StartCoroutine.

Implements AirshipSDK.IAirshipLiveActivityManager.

References AirshipSDK.LiveActivityInfo.

◆ ListAll()

IEnumerator AirshipSDK.AirshipLiveActivityManager.ListAll	(	Action< LiveActivityInfo[]>	onComplete,
		Action< Exception >	onError = `null`
	)

inline

Lists all Live Activities.

Parameters

onComplete	Callback invoked with all Live Activities.
onError	Optional callback invoked if an error occurs.

Returns: A coroutine that can be started with StartCoroutine.

Implements AirshipSDK.IAirshipLiveActivityManager.

References AirshipSDK.LiveActivityInfo.

◆ Start()

IEnumerator AirshipSDK.AirshipLiveActivityManager.Start	(	LiveActivityStartRequest	request,
		Action< LiveActivityInfo >	onComplete,
		Action< Exception >	onError = `null`
	)

inline

Starts a new Live Activity.

Parameters

request	The start request.
onComplete	Callback invoked with the created Live Activity.
onError	Optional callback invoked if an error occurs.

Returns: A coroutine that can be started with StartCoroutine.

Implements AirshipSDK.IAirshipLiveActivityManager.

References AirshipSDK.LiveActivityInfo.

◆ Update()

IEnumerator AirshipSDK.AirshipLiveActivityManager.Update	(	LiveActivityUpdateRequest	request,
		Action	onComplete = `null`,
		Action< Exception >	onError = `null`
	)

inline

Updates a Live Activity.

Parameters

request	The update request.
onComplete	Optional callback invoked when the operation completes.
onError	Optional callback invoked if an error occurs.

Returns: A coroutine that can be started with StartCoroutine.

Implements AirshipSDK.IAirshipLiveActivityManager.