Class: FilteredReadAllEventsCompleted

EventStore.Client.Messages.FilteredReadAllEventsCompleted(propertiesopt)

Represents a FilteredReadAllEventsCompleted.

Constructor

new FilteredReadAllEventsCompleted(propertiesopt)

Constructs a new FilteredReadAllEventsCompleted.
Parameters:
Name Type Attributes Description
properties EventStore.Client.Messages.IFilteredReadAllEventsCompleted <optional>
Properties to set
Implements:
  • IFilteredReadAllEventsCompleted
Source:

Members

commitPosition :Long

FilteredReadAllEventsCompleted commitPosition.
Type:
  • Long
Source:

error :string

FilteredReadAllEventsCompleted error.
Type:
  • string
Source:

events :Array.<EventStore.Client.Messages.IResolvedEvent>

FilteredReadAllEventsCompleted events.
Type:
Source:

isEndOfStream :boolean

FilteredReadAllEventsCompleted isEndOfStream.
Type:
  • boolean
Source:

nextCommitPosition :Long

FilteredReadAllEventsCompleted nextCommitPosition.
Type:
  • Long
Source:

nextPreparePosition :Long

FilteredReadAllEventsCompleted nextPreparePosition.
Type:
  • Long
Source:

preparePosition :Long

FilteredReadAllEventsCompleted preparePosition.
Type:
  • Long
Source:

result :EventStore.Client.Messages.FilteredReadAllEventsCompleted.FilteredReadAllResult

FilteredReadAllEventsCompleted result.
Type:
Source:

(static) FilteredReadAllResult :number

FilteredReadAllResult enum.
Type:
  • number
Properties:
Name Type Description
Success number Success value
NotModified number NotModified value
Error number Error value
AccessDenied number AccessDenied value
Source:

Methods

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

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

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

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

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

Decodes a FilteredReadAllEventsCompleted 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:
FilteredReadAllEventsCompleted
Type
EventStore.Client.Messages.FilteredReadAllEventsCompleted

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

Decodes a FilteredReadAllEventsCompleted 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:
FilteredReadAllEventsCompleted
Type
EventStore.Client.Messages.FilteredReadAllEventsCompleted

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

Encodes the specified FilteredReadAllEventsCompleted message. Does not implicitly verify messages.
Parameters:
Name Type Attributes Description
message EventStore.Client.Messages.IFilteredReadAllEventsCompleted FilteredReadAllEventsCompleted 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 FilteredReadAllEventsCompleted message, length delimited. Does not implicitly verify messages.
Parameters:
Name Type Attributes Description
message EventStore.Client.Messages.IFilteredReadAllEventsCompleted FilteredReadAllEventsCompleted message or plain object to encode
writer $protobuf.Writer <optional>
Writer to encode to
Source:
Returns:
Writer
Type
$protobuf.Writer

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

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

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for FilteredReadAllEventsCompleted
Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>
your custom typeUrlPrefix(default "type.googleapis.com")
Source:
Returns:
The default type url
Type
string

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

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

(static) verify(message) → {string|null}

Verifies a FilteredReadAllEventsCompleted 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 | null