Unsubscribers - Documentation

Constructor

new Unsubscribers(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new Unsubscribers service.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Extends

$protobuf.rpc.Service

Methods

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {Unsubscribers}

Creates new Unsubscribers service using the specified rpc implementation.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Returns:

Type	Description
Unsubscribers	RPC service. Useful where requests and/or responses are streamed.

createUnsubscriber(request, callback) → {undefined}

Calls CreateUnsubscriber.

Parameters:

Name	Type	Description
`request`	enfonica.messaging.v1.ICreateUnsubscriberRequest	CreateUnsubscriberRequest message or plain object
`callback`	enfonica.messaging.v1.Unsubscribers.CreateUnsubscriberCallback	Node-style callback called with the error, if any, and Unsubscriber

Returns:

Type	Description
undefined

createUnsubscriber(request) → {Promise.<enfonica.messaging.v1.Unsubscriber>}

Calls CreateUnsubscriber.

Parameters:

Name	Type	Description
`request`	enfonica.messaging.v1.ICreateUnsubscriberRequest	CreateUnsubscriberRequest message or plain object

Returns:

Type	Description
Promise.<enfonica.messaging.v1.Unsubscriber>	Promise

deleteUnsubscriber(request, callback) → {undefined}

Calls DeleteUnsubscriber.

Parameters:

Name	Type	Description
`request`	enfonica.messaging.v1.IDeleteUnsubscriberRequest	DeleteUnsubscriberRequest message or plain object
`callback`	enfonica.messaging.v1.Unsubscribers.DeleteUnsubscriberCallback	Node-style callback called with the error, if any, and Unsubscriber

Returns:

Type	Description
undefined

deleteUnsubscriber(request) → {Promise.<enfonica.messaging.v1.Unsubscriber>}

Calls DeleteUnsubscriber.

Parameters:

Name	Type	Description
`request`	enfonica.messaging.v1.IDeleteUnsubscriberRequest	DeleteUnsubscriberRequest message or plain object

Returns:

Type	Description
Promise.<enfonica.messaging.v1.Unsubscriber>	Promise

getUnsubscriber(request, callback) → {undefined}

Calls GetUnsubscriber.

Parameters:

Name	Type	Description
`request`	enfonica.messaging.v1.IGetUnsubscriberRequest	GetUnsubscriberRequest message or plain object
`callback`	enfonica.messaging.v1.Unsubscribers.GetUnsubscriberCallback	Node-style callback called with the error, if any, and Unsubscriber

Returns:

Type	Description
undefined

getUnsubscriber(request) → {Promise.<enfonica.messaging.v1.Unsubscriber>}

Calls GetUnsubscriber.

Parameters:

Name	Type	Description
`request`	enfonica.messaging.v1.IGetUnsubscriberRequest	GetUnsubscriberRequest message or plain object

Returns:

Type	Description
Promise.<enfonica.messaging.v1.Unsubscriber>	Promise

listUnsubscribers(request, callback) → {undefined}

Calls ListUnsubscribers.

Parameters:

Name	Type	Description
`request`	enfonica.messaging.v1.IListUnsubscribersRequest	ListUnsubscribersRequest message or plain object
`callback`	enfonica.messaging.v1.Unsubscribers.ListUnsubscribersCallback	Node-style callback called with the error, if any, and ListUnsubscribersResponse

Returns:

Type	Description
undefined

listUnsubscribers(request) → {Promise.<enfonica.messaging.v1.ListUnsubscribersResponse>}

Calls ListUnsubscribers.

Parameters:

Name	Type	Description
`request`	enfonica.messaging.v1.IListUnsubscribersRequest	ListUnsubscribersRequest message or plain object

Returns:

Type	Description
Promise.<enfonica.messaging.v1.ListUnsubscribersResponse>	Promise

updateUnsubscriber(request, callback) → {undefined}

Calls UpdateUnsubscriber.

Parameters:

Name	Type	Description
`request`	enfonica.messaging.v1.IUpdateUnsubscriberRequest	UpdateUnsubscriberRequest message or plain object
`callback`	enfonica.messaging.v1.Unsubscribers.UpdateUnsubscriberCallback	Node-style callback called with the error, if any, and Unsubscriber

Returns:

Type	Description
undefined

updateUnsubscriber(request) → {Promise.<enfonica.messaging.v1.Unsubscriber>}

Calls UpdateUnsubscriber.

Parameters:

Name	Type	Description
`request`	enfonica.messaging.v1.IUpdateUnsubscriberRequest	UpdateUnsubscriberRequest message or plain object

Returns:

Type	Description
Promise.<enfonica.messaging.v1.Unsubscriber>	Promise

Type Definitions

CreateUnsubscriberCallback(error, responseopt)

Callback as used by enfonica.messaging.v1.Unsubscribers#createUnsubscriber.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	enfonica.messaging.v1.Unsubscriber	<optional>	Unsubscriber

DeleteUnsubscriberCallback(error, responseopt)

Callback as used by enfonica.messaging.v1.Unsubscribers#deleteUnsubscriber.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	enfonica.messaging.v1.Unsubscriber	<optional>	Unsubscriber

GetUnsubscriberCallback(error, responseopt)

Callback as used by enfonica.messaging.v1.Unsubscribers#getUnsubscriber.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	enfonica.messaging.v1.Unsubscriber	<optional>	Unsubscriber

ListUnsubscribersCallback(error, responseopt)

Callback as used by enfonica.messaging.v1.Unsubscribers#listUnsubscribers.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	enfonica.messaging.v1.ListUnsubscribersResponse	<optional>	ListUnsubscribersResponse

UpdateUnsubscriberCallback(error, responseopt)

Callback as used by enfonica.messaging.v1.Unsubscribers#updateUnsubscriber.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	enfonica.messaging.v1.Unsubscriber	<optional>	Unsubscriber