Class: Azure::MobileEngagement::Mgmt::V2014_12_01::Models::CampaignListResult

Inherits:
CampaignStateResult show all
Includes:
MsRestAzure
Defined in:
lib/2014-12-01/generated/azure_mgmt_mobile_engagement/models/campaign_list_result.rb

Overview

Model object.

Instance Attribute Summary collapse

Attributes inherited from CampaignStateResult

#id

Attributes inherited from CampaignState

#state

Class Method Summary collapse

Instance Attribute Details

#activated_date ⇒ DateTime

present if not yet activated). The date conforms to the following format: ‘yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.

Returns:

  • (DateTime) —

    The date at which the campaign was activated (Not



23
24
25
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/models/campaign_list_result.rb', line 23

def activated_date
  @activated_date
end

#end_time ⇒ DateTime

specified. The date conforms to the following format: ‘yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. Applicable only to announcements and polls.

Returns:

  • (DateTime) —

    The date at which the campaign should be finished if



43
44
45
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/models/campaign_list_result.rb', line 43

def end_time
  @end_time
end

#finished_date ⇒ DateTime

present if not yet finished). The date conforms to the following format: ‘yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.

Returns:

  • (DateTime) —

    The date at which the campaign was finished (Not



29
30
31
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/models/campaign_list_result.rb', line 29

def finished_date
  @finished_date
end

#name ⇒ String

Returns Name of the campaign.

Returns:

  • (String) —

    Name of the campaign.



17
18
19
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/models/campaign_list_result.rb', line 17

def name
  @name
end

#start_time ⇒ DateTime

specified. The date conforms to the following format: ‘yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. Applicable only to announcements and polls.

Returns:

  • (DateTime) —

    The date at which the campaign should be started if



36
37
38
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/models/campaign_list_result.rb', line 36

def start_time
  @start_time
end

#timezone ⇒ String

‘endTime` dates. If not provided, the two date attributes are referencing to the device timezone. Applicable only to announcements and polls.

Returns:

  • (String) —

    The id of the time zone to use for the ‘startTime` and



50
51
52
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/models/campaign_list_result.rb', line 50

def timezone
  @timezone
end

Class Method Details

.mapper ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/models/campaign_list_result.rb', line 57

def self.mapper()
  {
    required: false,
    serialized_name: 'CampaignListResult',
    type: {
      name: 'Composite',
      class_name: 'CampaignListResult',
      model_properties: {
        state: {
          required: false,
          serialized_name: 'state',
          type: {
            name: 'String'
          }
        },
        id: {
          required: true,
          serialized_name: 'id',
          type: {
            name: 'Number'
          }
        },
        name: {
          required: false,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        activated_date: {
          required: false,
          serialized_name: 'activatedDate',
          type: {
            name: 'DateTime'
          }
        },
        finished_date: {
          required: false,
          serialized_name: 'finishedDate',
          type: {
            name: 'DateTime'
          }
        },
        start_time: {
          required: false,
          serialized_name: 'startTime',
          type: {
            name: 'DateTime'
          }
        },
        end_time: {
          required: false,
          serialized_name: 'endTime',
          type: {
            name: 'DateTime'
          }
        },
        timezone: {
          required: false,
          serialized_name: 'timezone',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end