Class: Jamf::OAPISchemas::IosBrandingConfiguration

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::IosBrandingConfiguration

Defined in:

lib/jamf/api/jamf_pro/oapi_schemas/ios_branding_configuration.rb

Overview

OAPI Object Model and Enums for: IosBrandingConfiguration

This class was automatically generated from the api/schema URL path on a Jamf Pro server version 11.6.1-t1718634702

This class may be used directly, e.g instances of other classes may use instances of this class as one of their own properties/attributes.

It may also be used as a superclass when implementing Jamf Pro API Resources in ruby-jss. The subclasses include appropriate mixins, and should expand on the basic functionality provided here.

Container Objects: Other object models that use this model as the value in one of their attributes.

- Jamf::OAPISchemas::IosBrandingSearchResults

Sub Objects: Other object models used by this model’s attributes.

Endpoints and Privileges: API endpoints and HTTP operations that use this object model, and the Jamf Pro privileges needed to access them.

- '/v1/self-service/branding/ios:POST' needs permissions:
  - Create Self Service Branding Configuration
- '/v1/self-service/branding/ios/{id}:GET' needs permissions:
  - Read Self Service Branding Configuration
- '/v1/self-service/branding/ios/{id}:PUT' needs permissions:
  - Update Self Service Branding Configuration

Constant Summary

OAPI_PROPERTIES =

{

  # @!attribute [r] id
  #   @return [String]
  id: {
    class: :j_id,
    identifier: :primary,
    readonly: true
  },

  # @!attribute brandingName
  #   @return [String]
  brandingName: {
    class: :string,
    required: true
  },

  # @!attribute iconId
  #   @return [Integer]
  iconId: {
    class: :integer
  },

  # @!attribute headerBackgroundColorCode
  #   @return [String]
  headerBackgroundColorCode: {
    class: :string,
    required: true
  },

  # @!attribute menuIconColorCode
  #   @return [String]
  menuIconColorCode: {
    class: :string,
    required: true
  },

  # @!attribute brandingNameColorCode
  #   @return [String]
  brandingNameColorCode: {
    class: :string,
    required: true
  },

  # @!attribute statusBarTextColor
  #   @return [String]
  statusBarTextColor: {
    class: :string,
    required: true
  }

}

Instance Attribute Summary

• #brandingName ⇒ String
• #brandingNameColorCode ⇒ String
• #headerBackgroundColorCode ⇒ String
• #iconId ⇒ Integer
• #id ⇒ String readonly
• #menuIconColorCode ⇒ String
• #statusBarTextColor ⇒ String

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#brandingName ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/ios_branding_configuration.rb', line 82

#brandingNameColorCode ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/ios_branding_configuration.rb', line 109

#headerBackgroundColorCode ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/ios_branding_configuration.rb', line 95

#iconId ⇒ Integer

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/ios_branding_configuration.rb', line 89

#id ⇒ String (readonly)

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/ios_branding_configuration.rb', line 74

#menuIconColorCode ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/ios_branding_configuration.rb', line 102

#statusBarTextColor ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/ios_branding_configuration.rb', line 116