Please Select Your Location

Thailand
Australia
Österreich
België
Canada
Canada - Français
中国
Česká republika
Denmark
Deutschland
France
HongKong
Iceland
India
Ireland
Italia
日本
Korea
Latvija
Lietuva
Lëtzebuerg
Malaysia
Malta
Mexico
Nederland
New Zealand
Norge
Polska
Portugal
Russia
Saudi Arabia
Singapore
Southeast Asia
España
Suisse
Suomi
Sverige
台灣
Ukraine
United Kingdom
United States
Việt Nam
المملكة العربية السعودية (Arabic)

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.

  1. Call the Top Level API using Viveport.Api.Init to initialize the VIVEPORT SDK. For Unity developers, this is typically called as Monobehavior Start() .
  2. Call User.IsReady() to initialize the User Profile API.
  3. Call the User Profile API functions:
    • Call GetUserId() to get the end user public ID.
    • Call GetUserName() to get the end user InfinityTag.
    • Call GetUserAvatarURL() to get the URL of the end user profile image.
  4. 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() .
Note: The end user sets their InfinityTag when they create their account in VIVEPORT. If the user didn’t specify this, the system will use their first name or a generic name (“Viveport User”) as the InfinityTag.

Create account page.jpg