Class: PersistentSubscriptionNakEvents

EventStore.Client.Messages.PersistentSubscriptionNakEvents(propertiesopt)

new PersistentSubscriptionNakEvents(propertiesopt)

Constructs a new PersistentSubscriptionNakEvents.
Parameters:
Name Type Attributes Description
properties EventStore.Client.Messages.PersistentSubscriptionNakEvents$Properties <optional>
Properties to set
Source:

Members

(static) NakAction :number

NakAction enum.
Type:
  • number
Properties:
Name Type Description
Unknown number Unknown value
Park number Park value
Retry number Retry value
Skip number Skip value
Stop number Stop value
Source:

action :EventStore.Client.Messages.PersistentSubscriptionNakEvents.NakAction

PersistentSubscriptionNakEvents action.
Type:
Source:

message :string

PersistentSubscriptionNakEvents message.
Type:
  • string
Source:

processedEventIds :Array.<Uint8Array>

PersistentSubscriptionNakEvents processedEventIds.
Type:
  • Array.<Uint8Array>
Source:

subscriptionId :string

PersistentSubscriptionNakEvents subscriptionId.
Type:
  • string
Source:

Methods

(static) create(propertiesopt) → {EventStore.Client.Messages.PersistentSubscriptionNakEvents}

Creates a new PersistentSubscriptionNakEvents instance using the specified properties.
Parameters:
Name Type Attributes Description
properties EventStore.Client.Messages.PersistentSubscriptionNakEvents$Properties <optional>
Properties to set
Source:
Returns:
PersistentSubscriptionNakEvents instance
Type
EventStore.Client.Messages.PersistentSubscriptionNakEvents

(static) decode(reader, lengthopt) → {EventStore.Client.Messages.PersistentSubscriptionNakEvents}

Decodes a PersistentSubscriptionNakEvents message from the specified reader or buffer.
Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array Reader or buffer to decode from
length number <optional>
Message length if known beforehand
Source:
Throws:
  • If the payload is not a reader or valid buffer
    Type
    Error
  • If required fields are missing
    Type
    $protobuf.util.ProtocolError
Returns:
PersistentSubscriptionNakEvents
Type
EventStore.Client.Messages.PersistentSubscriptionNakEvents

(static) decodeDelimited(reader) → {EventStore.Client.Messages.PersistentSubscriptionNakEvents}

Decodes a PersistentSubscriptionNakEvents message from the specified reader or buffer, length delimited.
Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array Reader or buffer to decode from
Source:
Throws:
  • If the payload is not a reader or valid buffer
    Type
    Error
  • If required fields are missing
    Type
    $protobuf.util.ProtocolError
Returns:
PersistentSubscriptionNakEvents
Type
EventStore.Client.Messages.PersistentSubscriptionNakEvents

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified PersistentSubscriptionNakEvents message. Does not implicitly verify messages.
Parameters:
Name Type Attributes Description
message EventStore.Client.Messages.PersistentSubscriptionNakEvents$Properties PersistentSubscriptionNakEvents message or plain object to encode
writer $protobuf.Writer <optional>
Writer to encode to
Source:
Returns:
Writer
Type
$protobuf.Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

Encodes the specified PersistentSubscriptionNakEvents message, length delimited. Does not implicitly verify messages.
Parameters:
Name Type Attributes Description
message EventStore.Client.Messages.PersistentSubscriptionNakEvents$Properties PersistentSubscriptionNakEvents message or plain object to encode
writer $protobuf.Writer <optional>
Writer to encode to
Source:
Returns:
Writer
Type
$protobuf.Writer

(static) from(object) → {EventStore.Client.Messages.PersistentSubscriptionNakEvents}

Creates a PersistentSubscriptionNakEvents message from a plain object. Also converts values to their respective internal types. This is an alias of EventStore.Client.Messages.PersistentSubscriptionNakEvents.fromObject.
Parameters:
Name Type Description
object Object.<string, *> Plain object
Source:
Returns:
PersistentSubscriptionNakEvents
Type
EventStore.Client.Messages.PersistentSubscriptionNakEvents

(static) fromObject(object) → {EventStore.Client.Messages.PersistentSubscriptionNakEvents}

Creates a PersistentSubscriptionNakEvents message from a plain object. Also converts values to their respective internal types.
Parameters:
Name Type Description
object Object.<string, *> Plain object
Source:
Returns:
PersistentSubscriptionNakEvents
Type
EventStore.Client.Messages.PersistentSubscriptionNakEvents

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a PersistentSubscriptionNakEvents message. Also converts values to other types if specified.
Parameters:
Name Type Attributes Description
message EventStore.Client.Messages.PersistentSubscriptionNakEvents PersistentSubscriptionNakEvents
options $protobuf.ConversionOptions <optional>
Conversion options
Source:
Returns:
Plain object
Type
Object.<string, *>

(static) verify(message) → (nullable) {string}

Verifies a PersistentSubscriptionNakEvents message.
Parameters:
Name Type Description
message Object.<string, *> Plain object to verify
Source:
Returns:
`null` if valid, otherwise the reason why it is not
Type
string

toJSON() → {Object.<string, *>}

Converts this PersistentSubscriptionNakEvents to JSON.
Source:
Returns:
JSON object
Type
Object.<string, *>

toObject(optionsopt) → {Object.<string, *>}

Creates a plain object from this PersistentSubscriptionNakEvents message. Also converts values to other types if specified.
Parameters:
Name Type Attributes Description
options $protobuf.ConversionOptions <optional>
Conversion options
Source:
Returns:
Plain object
Type
Object.<string, *>