EngagementSDK
The entry point for all interaction with the EngagementSDK.
Important
Concurrent instances of the EngagementSDK is not supported; Only one instance should exist at any time.-
The sdk’s delegate, currently only used to report setup errors
-
The EngagementSDKConfig used to initialize this instance of the EngagementSDK
-
A sponsorship client used for sponsorship related queries
-
A badge client used for badge related queries
-
A chat client used for chat related queries and updates
-
A reaction client used for
Reaction Space
‘s related queries -
A client used to for
Quest
s related queries -
A rewards client used for rewards related queries
-
Initializes an instance of the EngagementSDK
-
Gets the current user’s profile
-
-
Indicates an error after
See moreEngagementSDK
initialization, before it could be used.
-
A property to control the level of logging from the
EngagementSDK
.
-
A delegate that returns analytics events.
-
Returns whether widgets are paused for all sessions
-
Creates a new
ContentSession
instance using a SessionConfiguration object. -
Creates a new
ContentSession
instance using a SessionConfiguration object. -
Creates a new
ContentSession
instance using a SessionConfiguration object.
-
Sets a user’s display name and calls the completion block
-
-
Retrieves current user profile ID
-
Sets custom data on the current user’s profile
-
Creates a connection to a chat room.
-
Creates a public chat room with an optional title
-
Creates a chat room with an optional title and an ability to set the room’s visibility
-
Retrieve information about a chat room
-
Retrieve all the users who are members of a chat room
-
Retrieve all Chat Rooms the current user is a member of
-
Create a membership between the current user and a Chat Room
-
Deletes a membership between the current user and a Chat Room
-
Find out whether the current user is muted for a
roomID
-
Retrieve widget details of a widget by
id
andkind
-
-
Retrieves leaderboards for a given program
-
Retrieves leaderboard details
-
Retrieves a paginated list of leaderboard entries defined by
GetLeaderboardEntriesRequestOptions
-
Retrieves a paginated list of leaderboard entries for a leaderboard
-
Get a leaderboard entry profile
-
Get a leaderboard entry profile
-
Get Leaderboards on which the profile is ranked
-
Get Leaderboards views on which the profile is ranked
-
Retrieve all redemption keys associated with the current user profile
-
Redeem a redemption key by code
-
Redeem Key by the redemption key ID
-
Pauses widgets for all ContentSessions This is stored in UserDefaults and will persist on future app launches
-
Resumes widgets for all ContentSessions This is stored in UserDefaults and will persist on future app launches