class Azure::MobileEngagement::Mgmt::V2014_12_01::Models::CampaignResult

Model object.

Attributes

activated_date[RW]

@return [DateTime] The date at which the campaign was activated (Not present if not yet activated). The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

finished_date[RW]

@return [DateTime] The date at which the campaign was finished (Not present if not yet finished). The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

id[RW]

@return [Integer] Campaign identifier.

state[RW]

@return [CampaignStates] State of the campaign, or 'queued' when testing a campaign. Possible values include: 'draft', 'scheduled', 'in-progress', 'finished', 'queued'

Private Class Methods

mapper() click to toggle source

Mapper for CampaignResult class as Ruby Hash. This will be used for serialization/deserialization.

# File lib/2014-12-01/generated/azure_mgmt_mobile_engagement/models/campaign_result.rb, line 41
def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'CampaignResult',
    type: {
      name: 'Composite',
      class_name: 'CampaignResult',
      model_properties: {
        notification_title: {
          client_side_validation: true,
          required: false,
          serialized_name: 'notificationTitle',
          constraints: {
            MaxLength: 2000
          },
          type: {
            name: 'String'
          }
        },
        notification_message: {
          client_side_validation: true,
          required: false,
          serialized_name: 'notificationMessage',
          constraints: {
            MaxLength: 4000
          },
          type: {
            name: 'String'
          }
        },
        notification_image: {
          client_side_validation: true,
          required: false,
          serialized_name: 'notificationImage',
          constraints: {
            MaxLength: 65535
          },
          type: {
            name: 'ByteArray'
          }
        },
        notification_options: {
          client_side_validation: true,
          required: false,
          serialized_name: 'notificationOptions',
          type: {
            name: 'Composite',
            class_name: 'NotificationOptions'
          }
        },
        title: {
          client_side_validation: true,
          required: false,
          serialized_name: 'title',
          constraints: {
            MaxLength: 128
          },
          type: {
            name: 'String'
          }
        },
        body: {
          client_side_validation: true,
          required: false,
          serialized_name: 'body',
          constraints: {
            MaxLength: 65535
          },
          type: {
            name: 'String'
          }
        },
        action_button_text: {
          client_side_validation: true,
          required: false,
          serialized_name: 'actionButtonText',
          constraints: {
            MaxLength: 64
          },
          type: {
            name: 'String'
          }
        },
        exit_button_text: {
          client_side_validation: true,
          required: false,
          serialized_name: 'exitButtonText',
          constraints: {
            MaxLength: 64
          },
          type: {
            name: 'String'
          }
        },
        action_url: {
          client_side_validation: true,
          required: false,
          serialized_name: 'actionUrl',
          constraints: {
            MaxLength: 2000
          },
          type: {
            name: 'String'
          }
        },
        payload: {
          client_side_validation: true,
          required: false,
          serialized_name: 'payload',
          type: {
            name: 'Object'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'name',
          constraints: {
            MaxLength: 64
          },
          type: {
            name: 'String'
          }
        },
        audience: {
          client_side_validation: true,
          required: false,
          serialized_name: 'audience',
          type: {
            name: 'Composite',
            class_name: 'CampaignAudience'
          }
        },
        category: {
          client_side_validation: true,
          required: false,
          serialized_name: 'category',
          constraints: {
            MaxLength: 64
          },
          type: {
            name: 'String'
          }
        },
        push_mode: {
          client_side_validation: true,
          required: false,
          serialized_name: 'pushMode',
          default_value: 'real-time',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        delivery_time: {
          client_side_validation: true,
          required: false,
          serialized_name: 'deliveryTime',
          type: {
            name: 'String'
          }
        },
        delivery_activities: {
          client_side_validation: true,
          required: false,
          serialized_name: 'deliveryActivities',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        start_time: {
          client_side_validation: true,
          required: false,
          serialized_name: 'startTime',
          type: {
            name: 'String'
          }
        },
        end_time: {
          client_side_validation: true,
          required: false,
          serialized_name: 'endTime',
          type: {
            name: 'String'
          }
        },
        timezone: {
          client_side_validation: true,
          required: false,
          serialized_name: 'timezone',
          type: {
            name: 'String'
          }
        },
        notification_type: {
          client_side_validation: true,
          required: false,
          serialized_name: 'notificationType',
          default_value: 'popup',
          type: {
            name: 'String'
          }
        },
        notification_icon: {
          client_side_validation: true,
          required: false,
          serialized_name: 'notificationIcon',
          default_value: true,
          type: {
            name: 'Boolean'
          }
        },
        notification_closeable: {
          client_side_validation: true,
          required: false,
          serialized_name: 'notificationCloseable',
          default_value: true,
          type: {
            name: 'Boolean'
          }
        },
        notification_vibrate: {
          client_side_validation: true,
          required: false,
          serialized_name: 'notificationVibrate',
          default_value: false,
          type: {
            name: 'Boolean'
          }
        },
        notification_sound: {
          client_side_validation: true,
          required: false,
          serialized_name: 'notificationSound',
          default_value: false,
          type: {
            name: 'Boolean'
          }
        },
        notification_badge: {
          client_side_validation: true,
          required: false,
          serialized_name: 'notificationBadge',
          default_value: false,
          type: {
            name: 'Boolean'
          }
        },
        localization: {
          client_side_validation: true,
          required: false,
          serialized_name: 'localization',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'CampaignLocalizationElementType',
                type: {
                  name: 'Composite',
                  class_name: 'CampaignLocalization'
                }
            }
          }
        },
        questions: {
          client_side_validation: true,
          required: false,
          serialized_name: 'questions',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'PollQuestionElementType',
                type: {
                  name: 'Composite',
                  class_name: 'PollQuestion'
                }
            }
          }
        },
        id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'id',
          type: {
            name: 'Number'
          }
        },
        state: {
          client_side_validation: true,
          required: false,
          serialized_name: 'state',
          type: {
            name: 'String'
          }
        },
        activated_date: {
          client_side_validation: true,
          required: false,
          serialized_name: 'activatedDate',
          type: {
            name: 'DateTime'
          }
        },
        finished_date: {
          client_side_validation: true,
          required: false,
          serialized_name: 'finishedDate',
          type: {
            name: 'DateTime'
          }
        }
      }
    }
  }
end