Messaging class

The Messaging service allows you to send messages to any provider type (SMTP, push notification, SMS, etc.).

Constructors

Messaging(Client client)

Properties

client → Client

final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

createApnsProvider({required String providerId, required String name, String? authKey, String? authKeyId, String? teamId, String? bundleId, bool? sandbox, bool? enabled}) → Future<Provider>

Create APNS provider

createEmail({required String messageId, required String subject, required String content, List<String>? topics, List<String>? users, List<String>? targets, List<String>? cc, List<String>? bcc, List<String>? attachments, bool? draft, bool? html, String? scheduledAt}) → Future<Message>

Create email

createFcmProvider({required String providerId, required String name, Map? serviceAccountJSON, bool? enabled}) → Future<Provider>

Create FCM provider

createMailgunProvider({required String providerId, required String name, String? apiKey, String? domain, bool? isEuRegion, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail, bool? enabled}) → Future<Provider>

Create Mailgun provider

createMsg91Provider({required String providerId, required String name, String? templateId, String? senderId, String? authKey, bool? enabled}) → Future<Provider>

Create Msg91 provider

createPush({required String messageId, required String title, required String body, List<String>? topics, List<String>? users, List<String>? targets, Map? data, String? action, String? image, String? icon, String? sound, String? color, String? tag, String? badge, bool? draft, String? scheduledAt}) → Future<Message>

Create push notification

createSendgridProvider({required String providerId, required String name, String? apiKey, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail, bool? enabled}) → Future<Provider>

Create Sendgrid provider

createSms({required String messageId, required String content, List<String>? topics, List<String>? users, List<String>? targets, bool? draft, String? scheduledAt}) → Future<Message>

Create SMS

createSmtpProvider({required String providerId, required String name, required String host, int? port, String? username, String? password, SmtpEncryption? encryption, bool? autoTLS, String? mailer, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail, bool? enabled}) → Future<Provider>

Create SMTP provider

createSubscriber({required String topicId, required String subscriberId, required String targetId}) → Future<Subscriber>

Create subscriber

createTelesignProvider({required String providerId, required String name, String? from, String? customerId, String? apiKey, bool? enabled}) → Future<Provider>

Create Telesign provider

createTextmagicProvider({required String providerId, required String name, String? from, String? username, String? apiKey, bool? enabled}) → Future<Provider>

Create Textmagic provider

createTopic({required String topicId, required String name, List<String>? subscribe}) → Future<Topic>

Create topic

createTwilioProvider({required String providerId, required String name, String? from, String? accountSid, String? authToken, bool? enabled}) → Future<Provider>

Create Twilio provider

createVonageProvider({required String providerId, required String name, String? from, String? apiKey, String? apiSecret, bool? enabled}) → Future<Provider>

Create Vonage provider

delete({required String messageId}) → Future

Delete message

deleteProvider({required String providerId}) → Future

Delete provider

deleteSubscriber({required String topicId, required String subscriberId}) → Future

Delete subscriber

deleteTopic({required String topicId}) → Future

Delete topic

getMessage({required String messageId}) → Future<Message>

Get message

getProvider({required String providerId}) → Future<Provider>

Get provider

getSubscriber({required String topicId, required String subscriberId}) → Future<Subscriber>

Get subscriber

getTopic({required String topicId}) → Future<Topic>

Get topic

listMessageLogs({required String messageId, List<String>? queries}) → Future<LogList>

List message logs

listMessages({List<String>? queries, String? search}) → Future<MessageList>

List messages

listProviderLogs({required String providerId, List<String>? queries}) → Future<LogList>

List provider logs

listProviders({List<String>? queries, String? search}) → Future<ProviderList>

List providers

listSubscriberLogs({required String subscriberId, List<String>? queries}) → Future<LogList>

List subscriber logs

listSubscribers({required String topicId, List<String>? queries, String? search}) → Future<SubscriberList>

List subscribers

listTargets({required String messageId, List<String>? queries}) → Future<TargetList>

List message targets

listTopicLogs({required String topicId, List<String>? queries}) → Future<LogList>

List topic logs

listTopics({List<String>? queries, String? search}) → Future<TopicList>

List topics

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

updateApnsProvider({required String providerId, String? name, bool? enabled, String? authKey, String? authKeyId, String? teamId, String? bundleId, bool? sandbox}) → Future<Provider>

Update APNS provider

updateEmail({required String messageId, List<String>? topics, List<String>? users, List<String>? targets, String? subject, String? content, bool? draft, bool? html, List<String>? cc, List<String>? bcc, String? scheduledAt}) → Future<Message>

Update email

updateFcmProvider({required String providerId, String? name, bool? enabled, Map? serviceAccountJSON}) → Future<Provider>

Update FCM provider

updateMailgunProvider({required String providerId, String? name, String? apiKey, String? domain, bool? isEuRegion, bool? enabled, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail}) → Future<Provider>

Update Mailgun provider

updateMsg91Provider({required String providerId, String? name, bool? enabled, String? templateId, String? senderId, String? authKey}) → Future<Provider>

Update Msg91 provider

updatePush({required String messageId, List<String>? topics, List<String>? users, List<String>? targets, String? title, String? body, Map? data, String? action, String? image, String? icon, String? sound, String? color, String? tag, int? badge, bool? draft, String? scheduledAt}) → Future<Message>

Update push notification

updateSendgridProvider({required String providerId, String? name, bool? enabled, String? apiKey, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail}) → Future<Provider>

Update Sendgrid provider

updateSms({required String messageId, List<String>? topics, List<String>? users, List<String>? targets, String? content, bool? draft, String? scheduledAt}) → Future<Message>

Update SMS

updateSmtpProvider({required String providerId, String? name, String? host, int? port, String? username, String? password, SmtpEncryption? encryption, bool? autoTLS, String? mailer, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail, bool? enabled}) → Future<Provider>

Update SMTP provider

updateTelesignProvider({required String providerId, String? name, bool? enabled, String? customerId, String? apiKey, String? from}) → Future<Provider>

Update Telesign provider

updateTextmagicProvider({required String providerId, String? name, bool? enabled, String? username, String? apiKey, String? from}) → Future<Provider>

Update Textmagic provider

updateTopic({required String topicId, String? name, List<String>? subscribe}) → Future<Topic>

Update topic

updateTwilioProvider({required String providerId, String? name, bool? enabled, String? accountSid, String? authToken, String? from}) → Future<Provider>

Update Twilio provider

updateVonageProvider({required String providerId, String? name, bool? enabled, String? apiKey, String? apiSecret, String? from}) → Future<Provider>

Update Vonage provider

Operators

operator ==(Object other) → bool

The equality operator.

inherited