Class: Azure::MobileEngagement::Mgmt::V2014_12_01::Models::CampaignsListResult

Inherits:
Object
  • Object
show all
Includes:
MsRest::JSONable, MsRestAzure
Defined in:
lib/2014-12-01/generated/azure_mgmt_mobile_engagement/models/campaigns_list_result.rb

Overview

The campaigns list result.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

returned, this property describes a URI path to get the next results. This property is not set when reaching the last page.

Returns:

  • (String) —

    When using ‘top` parameter and if partial results are



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

def next_link
  @next_link
end

#next_method ⇒ Object

return [Proc] with next page method call.



25
26
27
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/models/campaigns_list_result.rb', line 25

def next_method
  @next_method
end

#value ⇒ Array<CampaignListResult>

Returns The list of campaigns.

Returns:



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

def value
  @value
end

Class Method Details

.mapper ⇒ Object

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



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
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/models/campaigns_list_result.rb', line 60

def self.mapper()
  {
    required: false,
    serialized_name: 'CampaignsListResult',
    type: {
      name: 'Composite',
      class_name: 'CampaignsListResult',
      model_properties: {
        value: {
          required: false,
          serialized_name: 'value',
          type: {
            name: 'Sequence',
            element: {
                required: false,
                serialized_name: 'CampaignListResultElementType',
                type: {
                  name: 'Composite',
                  class_name: 'CampaignListResult'
                }
            }
          }
        },
        next_link: {
          required: false,
          serialized_name: 'nextLink',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end

Instance Method Details

#get_all_items ⇒ Array<CampaignListResult>

Gets the rest of the items for the request, enabling auto-pagination.

Returns:



32
33
34
35
36
37
38
39
40
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/models/campaigns_list_result.rb', line 32

def get_all_items
  items = @value
  page = self
  while page.next_link != nil do
    page = page.get_next_page
    items.concat(page.value)
  end
  items
end

#get_next_page ⇒ CampaignsListResult

Gets the next page of results.

Returns:



47
48
49
50
51
52
53
54
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/models/campaigns_list_result.rb', line 47

def get_next_page
  response = @next_method.call(@next_link).value! unless @next_method.nil?
  unless response.nil?
    @next_link = response.body.next_link
    @value = response.body.value
    self
  end
end