Beamable.Common.Api.Mail.AbsMailApi Class Reference

Inheritance diagram for Beamable.Common.Api.Mail.AbsMailApi:

Collaboration diagram for Beamable.Common.Api.Mail.AbsMailApi:

Public Member Functions
Promise< SearchMailResponse >	SearchMail (SearchMailRequest request)
	Find mail given a SearchMailRequest argument. The request contains a set of SearchMailRequestClause that can be configured to search for specific types of mail. More...
Promise< ListMailResponse >	GetMail (string category, long startId=0, long limit=100)
	Get the latest mail for a player More...
Promise< EmptyResponse >	SendMail (MailSendRequest request)
	Must be sent from an admin user or a microservice. Send mail to one or many users. More...
Promise< EmptyResponse >	Update (MailUpdateRequest updates)
	Must be sent from an admin user or a microservice. Update a mailing after it has been sent. More...
Promise< EmptyResponse >	AcceptMany (MailAcceptManyRequest manyRequest)
	Accept all the attachments from a set of mail messages. More...
abstract Promise< MailQueryResponse >	GetCurrent (string scope="")
Public Member Functions inherited from Beamable.Common.Api.ISupportsGet< MailQueryResponse >
Promise< TData >	GetCurrent (string scope="")
	Manually fetch the available data. If the server hasn't delivered a new update, this method will not return the absolute latest data unless you pass forceRefresh as true. More...

Static Public Attributes
const string	SERVICE_NAME = "mail"

Protected Member Functions
	AbsMailApi (IBeamableRequester requester, IUserContext ctx)

Properties
IBeamableRequester	Requester [get]
IUserContext	Ctx [get]

Member Function Documentation

AcceptMany()

Promise< EmptyResponse > Beamable.Common.Api.Mail.AbsMailApi.AcceptMany ( MailAcceptManyRequest  manyRequest )

inline

Accept all the attachments from a set of mail messages.

Parameters

manyRequest

Request structure containing numeric message IDs.

GetMail()

Promise< ListMailResponse > Beamable.Common.Api.Mail.AbsMailApi.GetMail ( string  category, long  startId = 0, long  limit = 100  )

inline

Get the latest mail for a player

Parameters

category	The category of mail can be any string
startId	An offset can be used to page through the players new mail
limit	Limit how many messages can appear in the resulting ListMailResponse.result field.

Returns

A Promise containing a ListMailResponse with the player's latest mail.

Implements Beamable.Common.Api.Mail.IMailApi.

SearchMail()

Promise< SearchMailResponse > Beamable.Common.Api.Mail.AbsMailApi.SearchMail ( SearchMailRequest  request )

inline

Find mail given a SearchMailRequest argument. The request contains a set of SearchMailRequestClause that can be configured to search for specific types of mail.

Parameters

request

A SearchMailRequest to filter the player's mail with.

Returns

A Promise<T> containing a SearchMailResponse The response will include a set of SearchMailResponseClauses that correspond to each SearchMailRequestClause in the request.

Implements Beamable.Common.Api.Mail.IMailApi.

SendMail()

Promise< EmptyResponse > Beamable.Common.Api.Mail.AbsMailApi.SendMail ( MailSendRequest  request )

inline

Must be sent from an admin user or a microservice. Send mail to one or many users.

Parameters

request

A MailSendRequest

Returns

A Promise<T> representing the network request.

Implements Beamable.Common.Api.Mail.IMailApi.

Update()

Promise< EmptyResponse > Beamable.Common.Api.Mail.AbsMailApi.Update ( MailUpdateRequest  updates )

inline

Must be sent from an admin user or a microservice. Update a mailing after it has been sent.

Parameters

updates

A MailUpdateRequest

Returns

A Promise<T> representing the network request.

Implements Beamable.Common.Api.Mail.IMailApi.

---

The documentation for this class was generated from the following file:

• com.beamable/Common/Runtime/Api/Mail/AbsMailApi.cs