Class ChannelId

The unique identifier for a channel. Channels are created and destroyed automatically on demand.

Inheritance

object

ChannelId

Channel

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: VivoxUnity

Assembly: VivoxUnity.dll

Syntax

public class ChannelId

Constructors

ChannelId(string)

Declaration

public ChannelId(string uri)

Parameters

Type	Name	Description
string	uri

ChannelId(string, string, string, ChannelType, Channel3DProperties, string)

A constructor for creating an echo or non-positional channel.

Declaration

public ChannelId(string issuer, string name, string domain, ChannelType type = ChannelType.NonPositional, Channel3DProperties properties = null, string environmentId = null)

Parameters

Type	Name	Description
string	issuer	The issuer that is responsible for authorizing access to this channel.
string	name	The name of this channel.
string	domain	The Vivox domain that hosts this channel.
ChannelType	type	The channel type.
Channel3DProperties	properties	The 3D positional channel properties.
string	environmentId	Environment ID for Unity Game Service-specific integrations

Properties

Domain

This is a value that your developer support representative provides. It is subject to change if a different server-determined destination is provided during client connector creation.

Declaration

public string Domain { get; }

Property Value

Type	Description
string

IsEmpty

This is true if the Name, Domain, and Issuer are empty.

Declaration

public bool IsEmpty { get; }

Property Value

Type	Description
bool

Issuer

The issuer that is responsible for authorizing access to this channel.

Declaration

public string Issuer { get; }

Property Value

Type	Description
string

Name

The name of this channel.

Declaration

public string Name { get; }

Property Value

Type	Description
string

Properties

The 3D channel properties.

Declaration

public Channel3DProperties Properties { get; }

Property Value

Type	Description
Channel3DProperties

Type

The channel type.

Declaration

public ChannelType Type { get; }

Property Value

Type	Description
ChannelType

Methods

Equals(object)

Determine if two objects are equal.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj	The other object.

Returns

Type	Description
bool	True if the objects are of equal value.

Overrides

object.Equals(object)

GetHashCode()

A hash function for ChannelId.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A hash code for the current object.

Overrides

object.GetHashCode()

IsNullOrEmpty(ChannelId)

A test for an empty ChannelId.

Declaration

public static bool IsNullOrEmpty(ChannelId id)

Parameters

Type	Name	Description
ChannelId	id	The channel ID.

Returns

Type	Description
bool	True if the ID is null or empty.

ToString()

The network representation of the channel ID. Note: This will be refactored in the future so the internal network representation of the ChannelId is hidden.

Declaration

public override string ToString()

Returns

Type	Description
string	A URI for this channel.

Overrides

object.ToString()