Beamable SDK
Public Member Functions | List of all members
Beamable.Api.Sessions.SessionService Class Reference

This type defines the Client main entry point for the Session feature. More...

Public Member Functions

 SessionService (PlatformService platform, PlatformRequester requester)
 
Promise< EmptyResponseStartSession (User user, string advertisingId, string locale)
 Starts a new Beamable user session. A session will record user analytics and track the user's play times. This method is automatically called by the Beamable SDK anytime the user changes and when Beamable SDK is initialized. More...
 
Promise< EmptyResponseSendHeartbeat ()
 Notifies the Beamable platform that the session is still active. This method is automatically called at a standard interval by the Beamable SDK itself. More...
 
Promise< SessionGetHeartbeat (long gamerTag)
 

Detailed Description

This type defines the Client main entry point for the Session feature.

Related Links

img beamable-logo

Member Function Documentation

◆ SendHeartbeat()

Promise<EmptyResponse> Beamable.Api.Sessions.SessionService.SendHeartbeat ( )
inline

Notifies the Beamable platform that the session is still active. This method is automatically called at a standard interval by the Beamable SDK itself.

Returns

◆ StartSession()

Promise<EmptyResponse> Beamable.Api.Sessions.SessionService.StartSession ( User  user,
string  advertisingId,
string  locale 
)
inline

Starts a new Beamable user session. A session will record user analytics and track the user's play times. This method is automatically called by the Beamable SDK anytime the user changes and when Beamable SDK is initialized.

Parameters
advertisingId
locale
Returns

The documentation for this class was generated from the following file: