CampaignProtocol

@available(iOS 18, *)
public protocol CampaignProtocol

Protocol defining common properties for campaign models

  • Declaration

    Swift

    associatedtype AppAttributes : ActivityAttributes

  • Declaration

    Swift

    associatedtype ResultType : CampaignResultProtocol

  • Campaign Id unique to campaign

    Declaration

    Swift

    var campaignId: String { get }

  • Campaign name

    Declaration

    Swift

    var campaignName: String { get }

  • The type of delivery the updates will be pushed

    Declaration

    Swift

    var deliveryType: String { get }

  • The attribute type name that describes Widget data

    Declaration

    Swift

    var attributeType: String { get }

  • Id unique to campaign dynamic update instance

    Declaration

    Swift

    var instanceId: String { get }

  • App specific Live Activity static attributes

    Declaration

    Swift

    var appAttributes: AppAttributes { get }

  • App specific Live Activity dynamic attributes

    Declaration

    Swift

    var appContent: AppAttributes.ContentState { get }

  • The workspace Id campaign resides in

    Declaration

    Swift

    var workspaceId: String? { get }

  • Create the result type from the campaign data

    Declaration

    Swift

    func createResult(workspaceId: String) -> ResultType