Interface IVivoxTokenProviderInternal

Must be implemented by the RegisterTokenProvider(IVivoxTokenProviderInternal) caller. This object's responsibility is to provide an overridable implementation that will generate tokens for Vivox actions.

Namespace: Unity.Services.Vivox.Internal

Syntax

public interface IVivoxTokenProviderInternal

Methods

GetTokenAsync(String, Nullable<TimeSpan>, String, String, String, String, String)

This async method should implement the necessary steps to providing a valid Vivox token. After registration, this method will automatically be called whenever a token needs to be generated for a particular action. (e.g. login, channel join, mute). This token generation method will not be used if a developer provides their own IVivoxTokenProvider implementation to the Vivox service. If the requested action is a login to the Vivox service we will use the UAS token for that instead of this method as well.

Declaration

Task<string> GetTokenAsync(string issuer = null, TimeSpan? expiration = null, string userUri = null, string action = null, string conferenceUri = null, string fromUserUri = null, string realm = null)

Parameters

Type	Name	Description
String	issuer	Id of a title. Provided as part of the credentials delivered upon creating a project in the Unity Dashboard and enabling Vivox.
Nullable<TimeSpan>	expiration	When the token should expire.
String	userUri	Id of the target for actions such as muting and blocking.
String	action	The action for which a token is requested. e.g.: "login", "join", ...
String	conferenceUri	Id if the conference requesting the token.
String	fromUserUri	Id of the user requesting the token.
String	realm	Domain for which the token should be created.

Returns

Type	Description
Task<String>	A Vivox token string.