AWSPinpointTargetingCustomMessageActivity

Objective-C

@interface AWSPinpointTargetingCustomMessageActivity

Swift

class AWSPinpointTargetingCustomMessageActivity

The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.

  • The destination to send the custom message to. This value can be one of the following:

    • The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the custom message.

    • The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable deliveryUri;

    Swift

    var deliveryUri: String? { get set }
  • The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable endpointTypes;

    Swift

    var endpointTypes: [String]? { get set }
  • Specifies the message data included in a custom channel message that’s sent to participants in a journey.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSPinpointTargetingJourneyCustomMessage *_Nullable messageConfig;

    Swift

    var messageConfig: AWSPinpointTargetingJourneyCustomMessage? { get set }
  • The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable nextActivity;

    Swift

    var nextActivity: String? { get set }
  • The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable templateName;

    Swift

    var templateName: String? { get set }
  • The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

    If you don’t specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that’s been most recently reviewed and approved for use, depending on your workflow. It isn’t necessarily the latest version of a template.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable templateVersion;

    Swift

    var templateVersion: String? { get set }