Inheritance diagram for Beamable.Common.Api.Mail.IMailApi:
Collaboration diagram for Beamable.Common.Api.Mail.IMailApi:
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... | |
 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... | |
Member Function Documentation
◆ GetMail()
| Promise< ListMailResponse > Beamable.Common.Api.Mail.IMailApi.GetMail | ( | string | category, |
| long | startId = 0, |
||
| long | limit = 100 |
||
| ) |
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.
Implemented in Beamable.Common.Api.Mail.AbsMailApi.
◆ SearchMail()
| Promise< SearchMailResponse > Beamable.Common.Api.Mail.IMailApi.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.
- 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.
Implemented in Beamable.Common.Api.Mail.AbsMailApi.
◆ SendMail()
| Promise< EmptyResponse > Beamable.Common.Api.Mail.IMailApi.SendMail | ( | MailSendRequest | request | ) |
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.
Implemented in Beamable.Common.Api.Mail.AbsMailApi.
◆ Update()
| Promise< EmptyResponse > Beamable.Common.Api.Mail.IMailApi.Update | ( | MailUpdateRequest | updates | ) |
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.
Implemented in Beamable.Common.Api.Mail.AbsMailApi.
The documentation for this interface was generated from the following file:
- com.beamable/Common/Runtime/Api/Mail/IMailApi.cs
