Struct RoomId

Holds information about the room identifier.

Inherited Members
Namespace: Unity.Cloud.Presence
Syntax
public readonly struct RoomId

Constructors

RoomId(Guid)

Returns a RoomId using a Guid.

Declaration
public RoomId(Guid value)
Parameters
Type Name Description
Guid value

The guid representing the room identifier

RoomId(String)

Returns a RoomId using a String.

Declaration
public RoomId(string value)
Parameters
Type Name Description
String value

The string representing the room identifier

Fields

None

Returns the value of an identifier representing an invalid room ID.

Declaration
public static readonly RoomId None
Field Value
Type Description
RoomId

Methods

Equals(Object)

Validates if obj is a RoomId instance and has the same values as this instance.

Declaration
public override readonly bool Equals(object obj)
Parameters
Type Name Description
Object obj

Compare the values with this instance.
Returns
Type Description
Boolean

true if both instance have the same values; false otherwise.
Overrides

Equals(RoomId)

Returns whether two RoomId objects are equals.

Declaration
public readonly bool Equals(RoomId other)
Parameters
Type Name Description
RoomId other
Returns
Type Description
Boolean

true if both instance have the same values; false otherwise.

GetHashCode()

Computes a hash code for the object.

Declaration
public override readonly int GetHashCode()
Returns
Type Description
Int32

A hash code for the current object.
Overrides
Remarks
  • You should not assume that equal hash codes imply object equality.
  • You should never persist or use a hash code outside the application domain in which it was created, because the same object may hash differently across application domains, processes, and platforms.

ToString()

Gets the string representation of this RoomId.

Declaration
public override readonly string ToString()
Returns
Type Description
String

The string result.
Overrides

Operators

Equality(RoomId, RoomId)

Gets whether two RoomId instances are the same.

Declaration
public static bool operator ==(RoomId left, RoomId right)
Parameters
Type Name Description
RoomId left

Compare with this first instance.
RoomId right

Compare with this other instance.
Returns
Type Description
Boolean

true if both instances represent the same; false otherwise.

Explicit(RoomId to String)

Declaration
public static explicit operator string (RoomId sId)
Parameters
Type Name Description
RoomId sId
Returns
Type Description
String

Inequality(RoomId, RoomId)

Gets whether two RoomId instances are not the same.

Declaration
public static bool operator !=(RoomId left, RoomId right)
Parameters
Type Name Description
RoomId left

Compare with this first instance.
RoomId right

Compare with this other instance.
Returns
Type Description
Boolean

true if both instances are not the same; false if both instances are the same.

Extension Methods