Class WebSocketMessageProperties

Namespace

NetCord.Gateway

Assembly

NetCord.dll

public record WebSocketMessageProperties : IEquatable<WebSocketMessageProperties>

Inheritance

object

WebSocketMessageProperties

Implements

IEquatable<WebSocketMessageProperties>

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

WebSocketMessageProperties()

public WebSocketMessageProperties()

WebSocketMessageProperties(WebSocketMessageProperties)

protected WebSocketMessageProperties(WebSocketMessageProperties original)

Parameters

original WebSocketMessageProperties

Properties

EqualityContract

protected virtual Type EqualityContract { get; }

Property Value

Type

MessageFlags

The flags to apply to the message. Defaults to EndOfMessage.

public WebSocketMessageFlags? MessageFlags { get; set; }

Property Value

WebSocketMessageFlags?

MessageType

The type of message to send. Defaults to Text.

public WebSocketMessageType? MessageType { get; set; }

Property Value

WebSocketMessageType?

RetryHandling

The retry handling to apply to the message. Defaults to Retry.

public WebSocketRetryHandling? RetryHandling { get; set; }

Property Value

WebSocketRetryHandling?

Methods

Equals(WebSocketMessageProperties?)

public virtual bool Equals(WebSocketMessageProperties? other)

Parameters

other WebSocketMessageProperties

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

PrintMembers(StringBuilder)

protected virtual bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

ToString()

public override string ToString()

Returns

string

WithMessageFlags(WebSocketMessageFlags?)

The flags to apply to the message. Defaults to EndOfMessage.

public WebSocketMessageProperties WithMessageFlags(WebSocketMessageFlags? messageFlags)

Parameters

messageFlags WebSocketMessageFlags?

Returns

WebSocketMessageProperties

WithMessageType(WebSocketMessageType?)

The type of message to send. Defaults to Text.

public WebSocketMessageProperties WithMessageType(WebSocketMessageType? messageType)

Parameters

messageType WebSocketMessageType?

Returns

WebSocketMessageProperties

WithRetryHandling(WebSocketRetryHandling?)

The retry handling to apply to the message. Defaults to Retry.

public WebSocketMessageProperties WithRetryHandling(WebSocketRetryHandling? retryHandling)

Parameters

retryHandling WebSocketRetryHandling?

Returns

WebSocketMessageProperties

Operators

operator ==(WebSocketMessageProperties?, WebSocketMessageProperties?)

public static bool operator ==(WebSocketMessageProperties? left, WebSocketMessageProperties? right)

Parameters

left WebSocketMessageProperties

right WebSocketMessageProperties

Returns

bool

operator !=(WebSocketMessageProperties?, WebSocketMessageProperties?)

public static bool operator !=(WebSocketMessageProperties? left, WebSocketMessageProperties? right)

Parameters

left WebSocketMessageProperties

right WebSocketMessageProperties

Returns

bool