Skip to main content

A subscription request object handled by the server that has created the stream. It can be accepted or rejected.

Properties (2)

Property Type Default Required Description
arguments⚓︎ any x

Arguments passed with the subscription request.

instance⚓︎ Instance x

Instance of the application that wants to subscribe to the stream.

3 Methods

accept()⚓︎

() => void

Accepts the subscription request.

acceptOnBranch()⚓︎

(branchKey: string) => void

Accepts the request on a stream branch.

Parameters (1)

Name Type Required Description
branchKey⚓︎ string

Key of the branch on which to accept the request.

reject()⚓︎

(reason?: string) => void

Rejects the request.

Parameters (1)

Name Type Required Description
reason⚓︎ string x

Reason for rejecting the request.