ChannelId
Reference the ChannelId class for representing Vivox channels.
読み終わるまでの所要時間 2 分最終更新 1日前
The unique identifier for a channel. Channels are created and destroyed automatically on demand.
#include <ChannelId.h>Public Functions
Name | |
|---|---|
| ChannelId | CreateFromUri(const FString & uri, const TOptional< FString > & unityEnvironmentId =TOptional< FString >()) Internal use only. |
| bool | IsNullOrEmpty(ChannelId * id) True if the ID is null or empty. |
| ChannelId() Constructor. | |
| ChannelId(const FString & issuer, const FString & name, const FString & domain, ChannelType type =ChannelType::NonPositional, Channel3DProperties properties =Channel3DProperties(), const TOptional< FString > & unityEnvironmentId =TOptional< FString >()) Constructor. | |
| const FString & | Issuer() const The issuer that is responsible for authenticating this channel. |
| const FString & | Name() const The name you assigned to the channel. |
| const FString & | Domain() const The Vivox domain that provides service for this channel. |
| ChannelType | Type() const The type of channel. |
| Channel3DProperties | Properties() const The 3D properties of the channel. |
| const FString & | UnityEnvironmentId() const The Unity Environment of the UGS Project. |
| bool | IsEmpty() const True if Issuer, Name, and Domain are all empty, and Type is NonPositional. |
| bool | IsValid() const True if Issuer and Domain are non-empty, and Name and Properties meet restrictions. |
| FString | ToString() const Internal use only. |
Public Functions Documentation
function CreateFromUri
Internal use only.static ChannelId CreateFromUri( const FString & uri, const TOptional< FString > & unityEnvironmentId =TOptional< FString >())
function IsNullOrEmpty
True if the ID is null or empty.static bool IsNullOrEmpty( ChannelId * id)
function ChannelId
Constructor.ChannelId()
function ChannelId
Constructor. Parameters:ChannelId( const FString & issuer, const FString & name, const FString & domain, ChannelType type =ChannelType::NonPositional, Channel3DProperties properties =Channel3DProperties(), const TOptional< FString > & unityEnvironmentId =TOptional< FString >())
- issuer The issuer that is responsible for authenticating this channel.
- name The name you assigned to the channel.
- domain The Vivox domain that provides service for this channel, for example: mt1s.vivox.com.
- type The type of channel, each with built-in characteristics (for example, 3D positional effects).
- properties The 3D properties of the channel. Note: This is optional, and is only used for positional channels.
- unityEnvironmentId The Unity Environment Id, from the Unity Dashboard, to be embedded in the Accounts URI, primarily for Moderation requests
function Issuer
The issuer that is responsible for authenticating this channel.const FString & Issuer() const
function Name
The name you assigned to the channel.const FString & Name() const
function Domain
The Vivox domain that provides service for this channel.const FString & Domain() const
function Type
The type of channel.ChannelType Type() const
function Properties
The 3D properties of the channel.Channel3DProperties Properties() const
function UnityEnvironmentId
The Unity Environment of the UGS Project.const FString & UnityEnvironmentId() const
function IsEmpty
True if Issuer, Name, and Domain are all empty, and Type is NonPositional.bool IsEmpty() const
function IsValid
True if Issuer and Domain are non-empty, and Name and Properties meet restrictions.bool IsValid() const
function ToString
Internal use only.FString ToString() const