Example usage

The following example highlights how a developer might use the VIVEPORT User Profile API in their title.

Make sure you have a VIVEPORT ID and Key for your title before trying to implement any of the API functions.

Call the Top Level API using Viveport.Api.Init to initialize the VIVEPORT SDK. For Unity developers, this is typically called as Monobehavior Start() .
Call User.IsReady() to initialize the User Profile API.
Call the User Profile API functions:
- Call GetUserId() to get the end user public ID.
- Call GetUserName() to get the display name.
- Call GetUserAvatarURL() to get the URL of the end user profile image.
Call Viveport.Api.Shutdown to release VIVEPORT SDK resources when no longer needed. In Unity, this is typically either in MonoBehavior OnDestroy() or before Application.Quit() .

Previous Next