Class WebSocketPayloadProperties

Namespace

NetCord.Gateway

Assembly

NetCord.dll

public record WebSocketPayloadProperties : IEquatable<WebSocketPayloadProperties>

Inheritance

object

WebSocketPayloadProperties

Implements

IEquatable<WebSocketPayloadProperties>

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

WebSocketPayloadProperties()

public WebSocketPayloadProperties()

WebSocketPayloadProperties(WebSocketPayloadProperties)

protected WebSocketPayloadProperties(WebSocketPayloadProperties original)

Parameters

original WebSocketPayloadProperties

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(WebSocketPayloadProperties?)

public virtual bool Equals(WebSocketPayloadProperties? other)

Parameters

other WebSocketPayloadProperties

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 WebSocketPayloadProperties WithMessageFlags(WebSocketMessageFlags? messageFlags)

Parameters

messageFlags WebSocketMessageFlags?

Returns

WebSocketPayloadProperties

WithMessageType(WebSocketMessageType?)

The type of message to send. Defaults to Text.

public WebSocketPayloadProperties WithMessageType(WebSocketMessageType? messageType)

Parameters

messageType WebSocketMessageType?

Returns

WebSocketPayloadProperties

WithRetryHandling(WebSocketRetryHandling?)

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

public WebSocketPayloadProperties WithRetryHandling(WebSocketRetryHandling? retryHandling)

Parameters

retryHandling WebSocketRetryHandling?

Returns

WebSocketPayloadProperties

Operators

operator ==(WebSocketPayloadProperties?, WebSocketPayloadProperties?)

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

Parameters

left WebSocketPayloadProperties

right WebSocketPayloadProperties

Returns

bool

operator !=(WebSocketPayloadProperties?, WebSocketPayloadProperties?)

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

Parameters

left WebSocketPayloadProperties

right WebSocketPayloadProperties

Returns

bool