Class SendMessageParams.Message.To
-
- All Implemented Interfaces:
public final class SendMessageParams.Message.ToThe recipient or a list of recipients of the message
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceSendMessageParams.Message.To.VisitorAn interface that defines how to map each variant of To to a value of type T.
public final classSendMessageParams.Message.To.RecipientA single recipient of the message. Choose one of the following types based on how you want to identify the recipient: - User: Send to a specific user by user_id, email, or phone number - Audience: Send to all users in an audience - List: Send to all users in a list - List Pattern: Send to users in lists matching a pattern - Slack: Send via Slack (channel, email, or user_id) - MS Teams: Send via Microsoft Teams - PagerDuty: Send via PagerDuty - Webhook: Send via webhook
-
Method Summary
Modifier and Type Method Description final Optional<UserRecipient>userRecipient()Send to a specific user by user_id, email, phone_number, or list_id final Optional<AudienceRecipient>audienceRecipient()Send to all users in an audience final Optional<ListRecipient>listRecipient()Send to all users in a specific list final Optional<ListPatternRecipient>listPatternRecipient()Send to users in lists matching a pattern final Optional<SlackRecipient>slackRecipient()Send via Slack (channel, email, or user_id) final Optional<MsTeamsRecipient>msTeamsRecipient()Send via Microsoft Teams final Optional<PagerdutyRecipient>pagerdutyRecipient()Send via PagerDuty final Optional<WebhookRecipient>webhookRecipient()Send via webhook final Optional<List<SendMessageParams.Message.To.Recipient>>recipients()final BooleanisUserRecipient()final BooleanisAudienceRecipient()final BooleanisListRecipient()final BooleanisListPatternRecipient()final BooleanisSlackRecipient()final BooleanisMsTeamsRecipient()final BooleanisPagerdutyRecipient()final BooleanisWebhookRecipient()final BooleanisRecipients()final UserRecipientasUserRecipient()Send to a specific user by user_id, email, phone_number, or list_id final AudienceRecipientasAudienceRecipient()Send to all users in an audience final ListRecipientasListRecipient()Send to all users in a specific list final ListPatternRecipientasListPatternRecipient()Send to users in lists matching a pattern final SlackRecipientasSlackRecipient()Send via Slack (channel, email, or user_id) final MsTeamsRecipientasMsTeamsRecipient()Send via Microsoft Teams final PagerdutyRecipientasPagerdutyRecipient()Send via PagerDuty final WebhookRecipientasWebhookRecipient()Send via webhook final List<SendMessageParams.Message.To.Recipient>asRecipients()final Optional<JsonValue>_json()final <T extends Any> Taccept(SendMessageParams.Message.To.Visitor<T> visitor)Maps this instance's current variant to a value of type T using the given visitor. final SendMessageParams.Message.Tovalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static SendMessageParams.Message.ToofUserRecipient(UserRecipient userRecipient)Send to a specific user by user_id, email, phone_number, or list_id final static SendMessageParams.Message.ToofAudienceRecipient(AudienceRecipient audienceRecipient)Send to all users in an audience final static SendMessageParams.Message.ToofListRecipient(ListRecipient listRecipient)Send to all users in a specific list final static SendMessageParams.Message.ToofListPatternRecipient(ListPatternRecipient listPatternRecipient)Send to users in lists matching a pattern final static SendMessageParams.Message.ToofSlackRecipient(SlackRecipient slackRecipient)Send via Slack (channel, email, or user_id) final static SendMessageParams.Message.ToofMsTeamsRecipient(MsTeamsRecipient msTeamsRecipient)Send via Microsoft Teams final static SendMessageParams.Message.ToofPagerdutyRecipient(PagerdutyRecipient pagerdutyRecipient)Send via PagerDuty final static SendMessageParams.Message.ToofWebhookRecipient(WebhookRecipient webhookRecipient)Send via webhook final static SendMessageParams.Message.ToofRecipients(List<SendMessageParams.Message.To.Recipient> recipients)-
-
Method Detail
-
userRecipient
final Optional<UserRecipient> userRecipient()
Send to a specific user by user_id, email, phone_number, or list_id
-
audienceRecipient
final Optional<AudienceRecipient> audienceRecipient()
Send to all users in an audience
-
listRecipient
final Optional<ListRecipient> listRecipient()
Send to all users in a specific list
-
listPatternRecipient
final Optional<ListPatternRecipient> listPatternRecipient()
Send to users in lists matching a pattern
-
slackRecipient
final Optional<SlackRecipient> slackRecipient()
Send via Slack (channel, email, or user_id)
-
msTeamsRecipient
final Optional<MsTeamsRecipient> msTeamsRecipient()
Send via Microsoft Teams
-
pagerdutyRecipient
final Optional<PagerdutyRecipient> pagerdutyRecipient()
Send via PagerDuty
-
webhookRecipient
final Optional<WebhookRecipient> webhookRecipient()
Send via webhook
-
recipients
final Optional<List<SendMessageParams.Message.To.Recipient>> recipients()
-
isUserRecipient
final Boolean isUserRecipient()
-
isAudienceRecipient
final Boolean isAudienceRecipient()
-
isListRecipient
final Boolean isListRecipient()
-
isListPatternRecipient
final Boolean isListPatternRecipient()
-
isSlackRecipient
final Boolean isSlackRecipient()
-
isMsTeamsRecipient
final Boolean isMsTeamsRecipient()
-
isPagerdutyRecipient
final Boolean isPagerdutyRecipient()
-
isWebhookRecipient
final Boolean isWebhookRecipient()
-
isRecipients
final Boolean isRecipients()
-
asUserRecipient
final UserRecipient asUserRecipient()
Send to a specific user by user_id, email, phone_number, or list_id
-
asAudienceRecipient
final AudienceRecipient asAudienceRecipient()
Send to all users in an audience
-
asListRecipient
final ListRecipient asListRecipient()
Send to all users in a specific list
-
asListPatternRecipient
final ListPatternRecipient asListPatternRecipient()
Send to users in lists matching a pattern
-
asSlackRecipient
final SlackRecipient asSlackRecipient()
Send via Slack (channel, email, or user_id)
-
asMsTeamsRecipient
final MsTeamsRecipient asMsTeamsRecipient()
Send via Microsoft Teams
-
asPagerdutyRecipient
final PagerdutyRecipient asPagerdutyRecipient()
Send via PagerDuty
-
asWebhookRecipient
final WebhookRecipient asWebhookRecipient()
Send via webhook
-
asRecipients
final List<SendMessageParams.Message.To.Recipient> asRecipients()
-
accept
final <T extends Any> T accept(SendMessageParams.Message.To.Visitor<T> visitor)
Maps this instance's current variant to a value of type T using the given visitor.
Note that this method is not forwards compatible with new variants from the API, unless visitor overrides Visitor.unknown. To handle variants not known to this version of the SDK gracefully, consider overriding Visitor.unknown:
import com.courier.core.JsonValue; import java.util.Optional; Optional<String> result = to.accept(new To.Visitor<Optional<String>>() { @Override public Optional<String> visitUserRecipient(UserRecipient userRecipient) { return Optional.of(userRecipient.toString()); } // ... @Override public Optional<String> unknown(JsonValue json) { // Or inspect the `json`. return Optional.empty(); } });
-
validate
final SendMessageParams.Message.To validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
ofUserRecipient
final static SendMessageParams.Message.To ofUserRecipient(UserRecipient userRecipient)
Send to a specific user by user_id, email, phone_number, or list_id
-
ofAudienceRecipient
final static SendMessageParams.Message.To ofAudienceRecipient(AudienceRecipient audienceRecipient)
Send to all users in an audience
-
ofListRecipient
final static SendMessageParams.Message.To ofListRecipient(ListRecipient listRecipient)
Send to all users in a specific list
-
ofListPatternRecipient
final static SendMessageParams.Message.To ofListPatternRecipient(ListPatternRecipient listPatternRecipient)
Send to users in lists matching a pattern
-
ofSlackRecipient
final static SendMessageParams.Message.To ofSlackRecipient(SlackRecipient slackRecipient)
Send via Slack (channel, email, or user_id)
-
ofMsTeamsRecipient
final static SendMessageParams.Message.To ofMsTeamsRecipient(MsTeamsRecipient msTeamsRecipient)
Send via Microsoft Teams
-
ofPagerdutyRecipient
final static SendMessageParams.Message.To ofPagerdutyRecipient(PagerdutyRecipient pagerdutyRecipient)
Send via PagerDuty
-
ofWebhookRecipient
final static SendMessageParams.Message.To ofWebhookRecipient(WebhookRecipient webhookRecipient)
Send via webhook
-
ofRecipients
final static SendMessageParams.Message.To ofRecipients(List<SendMessageParams.Message.To.Recipient> recipients)
-
-
-
-