This type defines the Client main entry point for the Mail feature. More...
Inheritance diagram for Beamable.Api.Mail.MailService:
Collaboration diagram for Beamable.Api.Mail.MailService:
Public Member Functions | |
| MailService (IPlatformService platform, IBeamableRequester requester, IDependencyProvider provider) | |
| override Promise< MailQueryResponse > | GetCurrent (string scope="") |
 Public Member Functions inherited from Beamable.Common.Api.Mail.AbsMailApi | |
| 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... | |
| 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... | |
Properties | |
| MailSubscription | Subscribable [get] |
| Properties inherited from Beamable.Common.Api.Mail.AbsMailApi | |
| IBeamableRequester | Requester [get] |
| IUserContext | Ctx [get] |
| Properties inherited from Beamable.Api.IHasPlatformSubscriber< MailSubscription, MailQueryResponse, MailQueryResponse > | |
| TPlatformSubscriber | Subscribable [get] |
| Allows scopes to consume fresh data when available. | |
Additional Inherited Members | |
| Static Public Attributes inherited from Beamable.Common.Api.Mail.AbsMailApi | |
| const string | SERVICE_NAME = "mail" |
| Protected Member Functions inherited from Beamable.Common.Api.Mail.AbsMailApi | |
| AbsMailApi (IBeamableRequester requester, IUserContext ctx) | |
Detailed Description
This type defines the Client main entry point for the Mail feature.
Related Links
- See the Mail feature documentation
- See Beamable.API script reference
Member Function Documentation
◆ GetCurrent()
|
virtual |
Implements Beamable.Common.Api.Mail.AbsMailApi.
The documentation for this class was generated from the following file:
- com.beamable/Runtime/Core/Platform/SDK/Mail/MailService.cs
