Class: Azure::MobileEngagement::Mgmt::V2014_12_01::Models::CampaignAudience

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

Overview

Specify which users will be targeted by this campaign. By default, all users will be targeted. If you set ‘pushMode` property to `manual`, the only thing you can specify in the audience is the push quota filter. An audience is a boolean expression made of criteria (variables) operators (`not`, `and` or `or`) and parenthesis. Additionally, a set of filters can be added to an audience. 65535 bytes max as per JSON encoding.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#criteria ⇒ Hash{String => Criterion}

Returns Criteria by name.

Returns:

  • (Hash{String => Criterion}) —

    Criteria by name.



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

def criteria
  @criteria
end

#expression ⇒ String

operators (‘not`, `and` or `or`) and parenthesis. Criterion names in the audience expression must start with a capital letter and can only contain alphanumeric (A-Z,a-z,0-9) and underscore (_) characters.

Returns:

  • (String) —

    Boolean expression made of criteria (variables)



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

def expression
  @expression
end

#filters ⇒ Array<Filter>

Returns Global filters applied to all devices.

Returns:

  • (Array<Filter>) —

    Global filters applied to all devices.



32
33
34
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/models/campaign_audience.rb', line 32

def filters
  @filters
end

Class Method Details

.mapper ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
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
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/models/campaign_audience.rb', line 39

def self.mapper()
  {
    required: false,
    serialized_name: 'Campaign_audience',
    type: {
      name: 'Composite',
      class_name: 'CampaignAudience',
      model_properties: {
        expression: {
          required: false,
          serialized_name: 'expression',
          type: {
            name: 'String'
          }
        },
        criteria: {
          required: false,
          serialized_name: 'criteria',
          type: {
            name: 'Dictionary',
            value: {
                required: false,
                serialized_name: 'CriterionElementType',
                type: {
                  name: 'Composite',
                  polymorphic_discriminator: 'type',
                  uber_parent: 'Criterion',
                  class_name: 'Criterion'
                }
            }
          }
        },
        filters: {
          required: false,
          serialized_name: 'filters',
          type: {
            name: 'Sequence',
            element: {
                required: false,
                serialized_name: 'FilterElementType',
                type: {
                  name: 'Composite',
                  polymorphic_discriminator: 'type',
                  uber_parent: 'Filter',
                  class_name: 'Filter'
                }
            }
          }
        }
      }
    }
  }
end