messagepickup

Documentation

Index

• type Client
  • func New(ctx provider) (*Client, error)
  • func (r *Client) BatchPickup(connectionID string, size int) (int, error)
  • func (r *Client) Noop(connectionID string) error
  • func (r *Client) StatusRequest(connectionID string) (*messagepickup.Status, error)

Types

type Client

type Client struct {
	service.Event
	// contains filtered or unexported fields
}

Client enable access to message pickup api.

func New

func New(ctx provider) (*Client, error)

New return new instance of messagepickup client.

func (*Client) BatchPickup

func (r *Client) BatchPickup(connectionID string, size int) (int, error)

BatchPickup request to have multiple waiting messages sent inside a batch message to the DID.

func (*Client) Noop

func (r *Client) Noop(connectionID string) error

Noop a message to reestablish a connection when there is no other reason to message the mediator.

func (*Client) StatusRequest

func (r *Client) StatusRequest(connectionID string) (*messagepickup.Status, error)

StatusRequest request a status message.