Documentation

OrganizationsorganizationIdbrandingPoliciesbrandingPolicyIdHelpSettings implements ModelInterface, ArrayAccess

OrganizationsorganizationIdbrandingPoliciesbrandingPolicyIdHelpSettings Class Doc Comment

Tags
category

Class

description

Settings for describing the modifications to various Help page features. Each property in this object accepts one of 'default or inherit' (do not modify functionality), 'hide' (remove the section from Dashboard), or 'show' (always show the section on Dashboard). Some properties in this object also accept custom HTML used to replace the section on Dashboard; see the documentation for each property to see the allowed values.

author

Swagger Codegen team

link
https://github.com/swagger-api/swagger-codegen

Interfaces, Classes and Traits

ModelInterface
Interface abstracting model access.
ArrayAccess

Table of Contents

API_DOCS_SUBTAB_DEFAULT_OR_INHERIT  = 'default or inherit'
API_DOCS_SUBTAB_HIDE  = 'hide'
API_DOCS_SUBTAB_SHOW  = 'show'
CASES_SUBTAB_DEFAULT_OR_INHERIT  = 'default or inherit'
CASES_SUBTAB_HIDE  = 'hide'
CASES_SUBTAB_SHOW  = 'show'
COMMUNITY_SUBTAB_DEFAULT_OR_INHERIT  = 'default or inherit'
COMMUNITY_SUBTAB_HIDE  = 'hide'
COMMUNITY_SUBTAB_SHOW  = 'show'
DATA_PROTECTION_REQUESTS_SUBTAB_DEFAULT_OR_INHERIT  = 'default or inherit'
DATA_PROTECTION_REQUESTS_SUBTAB_HIDE  = 'hide'
DATA_PROTECTION_REQUESTS_SUBTAB_SHOW  = 'show'
DISCRIMINATOR  = null
FIREWALL_INFO_SUBTAB_DEFAULT_OR_INHERIT  = 'default or inherit'
FIREWALL_INFO_SUBTAB_HIDE  = 'hide'
FIREWALL_INFO_SUBTAB_SHOW  = 'show'
GET_HELP_SUBTAB_DEFAULT_OR_INHERIT  = 'default or inherit'
GET_HELP_SUBTAB_HIDE  = 'hide'
GET_HELP_SUBTAB_SHOW  = 'show'
HARDWARE_REPLACEMENTS_SUBTAB_DEFAULT_OR_INHERIT  = 'default or inherit'
HARDWARE_REPLACEMENTS_SUBTAB_HIDE  = 'hide'
HARDWARE_REPLACEMENTS_SUBTAB_SHOW  = 'show'
HELP_TAB_DEFAULT_OR_INHERIT  = 'default or inherit'
HELP_TAB_HIDE  = 'hide'
HELP_TAB_SHOW  = 'show'
NEW_FEATURES_SUBTAB_DEFAULT_OR_INHERIT  = 'default or inherit'
NEW_FEATURES_SUBTAB_HIDE  = 'hide'
NEW_FEATURES_SUBTAB_SHOW  = 'show'
SM_FORUMS_DEFAULT_OR_INHERIT  = 'default or inherit'
SM_FORUMS_HIDE  = 'hide'
SM_FORUMS_SHOW  = 'show'
UNIVERSAL_SEARCH_KNOWLEDGE_BASE_SEARCH_DEFAULT_OR_INHERIT  = 'default or inherit'
UNIVERSAL_SEARCH_KNOWLEDGE_BASE_SEARCH_HIDE  = 'hide'
UNIVERSAL_SEARCH_KNOWLEDGE_BASE_SEARCH_SHOW  = 'show'
$attributeMap  : array<string|int, string>
Array of attributes where the key is the local name, and the value is the original name
$container  : array<string|int, mixed>
Associative array for storing property values
$getters  : array<string|int, string>
Array of attributes to getter functions (for serialization of requests)
$setters  : array<string|int, string>
Array of attributes to setter functions (for deserialization of responses)
$swaggerFormats  : array<string|int, string>
Array of property to format mappings. Used for (de)serialization
$swaggerModelName  : string
The original name of the model.
$swaggerTypes  : array<string|int, string>
Array of property to type mappings. Used for (de)serialization
__construct()  : mixed
Constructor
__toString()  : string
Gets the string presentation of the object
attributeMap()  : array<string|int, mixed>
Array of attributes where the key is the local name, and the value is the original name
getApiDocsSubtab()  : string
Gets api_docs_subtab
getApiDocsSubtabAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getCasesSubtab()  : string
Gets cases_subtab
getCasesSubtabAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getCiscoMerakiProductDocumentation()  : string
Gets cisco_meraki_product_documentation
getCommunitySubtab()  : string
Gets community_subtab
getCommunitySubtabAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getDataProtectionRequestsSubtab()  : string
Gets data_protection_requests_subtab
getDataProtectionRequestsSubtabAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getFirewallInfoSubtab()  : string
Gets firewall_info_subtab
getFirewallInfoSubtabAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getGetHelpSubtab()  : string
Gets get_help_subtab
getGetHelpSubtabAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getGetHelpSubtabKnowledgeBaseSearch()  : string
Gets get_help_subtab_knowledge_base_search
getHardwareReplacementsSubtab()  : string
Gets hardware_replacements_subtab
getHardwareReplacementsSubtabAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getHelpTab()  : string
Gets help_tab
getHelpTabAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getModelName()  : string
The original name of the model.
getNewFeaturesSubtab()  : string
Gets new_features_subtab
getNewFeaturesSubtabAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getSmForums()  : string
Gets sm_forums
getSmForumsAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getSupportContactInfo()  : string
Gets support_contact_info
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUniversalSearchKnowledgeBaseSearch()  : string
Gets universal_search_knowledge_base_search
getUniversalSearchKnowledgeBaseSearchAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
listInvalidProperties()  : array<string|int, mixed>
Show all the invalid properties with reasons.
offsetExists()  : bool
Returns true if offset exists. False otherwise.
offsetGet()  : mixed
Gets offset.
offsetSet()  : void
Sets value based on offset.
offsetUnset()  : void
Unsets offset.
setApiDocsSubtab()  : $this
Sets api_docs_subtab
setCasesSubtab()  : $this
Sets cases_subtab
setCiscoMerakiProductDocumentation()  : $this
Sets cisco_meraki_product_documentation
setCommunitySubtab()  : $this
Sets community_subtab
setDataProtectionRequestsSubtab()  : $this
Sets data_protection_requests_subtab
setFirewallInfoSubtab()  : $this
Sets firewall_info_subtab
setGetHelpSubtab()  : $this
Sets get_help_subtab
setGetHelpSubtabKnowledgeBaseSearch()  : $this
Sets get_help_subtab_knowledge_base_search
setHardwareReplacementsSubtab()  : $this
Sets hardware_replacements_subtab
setHelpTab()  : $this
Sets help_tab
setNewFeaturesSubtab()  : $this
Sets new_features_subtab
setSmForums()  : $this
Sets sm_forums
setSupportContactInfo()  : $this
Sets support_contact_info
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUniversalSearchKnowledgeBaseSearch()  : $this
Sets universal_search_knowledge_base_search
swaggerFormats()  : array<string|int, mixed>
Array of property to format mappings. Used for (de)serialization
swaggerTypes()  : array<string|int, mixed>
Array of property to type mappings. Used for (de)serialization
valid()  : bool
Validate all the properties in the model return true if all passed

Constants

Properties

$attributeMap

Array of attributes where the key is the local name, and the value is the original name

protected static array<string|int, string> $attributeMap = ['help_tab' => 'helpTab', 'get_help_subtab' => 'getHelpSubtab', 'community_subtab' => 'communitySubtab', 'cases_subtab' => 'casesSubtab', 'data_protection_requests_subtab' => 'dataProtectionRequestsSubtab', 'get_help_subtab_knowledge_base_search' => 'getHelpSubtabKnowledgeBaseSearch', 'universal_search_knowledge_base_search' => 'universalSearchKnowledgeBaseSearch', 'cisco_meraki_product_documentation' => 'ciscoMerakiProductDocumentation', 'support_contact_info' => 'supportContactInfo', 'new_features_subtab' => 'newFeaturesSubtab', 'firewall_info_subtab' => 'firewallInfoSubtab', 'api_docs_subtab' => 'apiDocsSubtab', 'hardware_replacements_subtab' => 'hardwareReplacementsSubtab', 'sm_forums' => 'smForums']

$getters

Array of attributes to getter functions (for serialization of requests)

protected static array<string|int, string> $getters = ['help_tab' => 'getHelpTab', 'get_help_subtab' => 'getGetHelpSubtab', 'community_subtab' => 'getCommunitySubtab', 'cases_subtab' => 'getCasesSubtab', 'data_protection_requests_subtab' => 'getDataProtectionRequestsSubtab', 'get_help_subtab_knowledge_base_search' => 'getGetHelpSubtabKnowledgeBaseSearch', 'universal_search_knowledge_base_search' => 'getUniversalSearchKnowledgeBaseSearch', 'cisco_meraki_product_documentation' => 'getCiscoMerakiProductDocumentation', 'support_contact_info' => 'getSupportContactInfo', 'new_features_subtab' => 'getNewFeaturesSubtab', 'firewall_info_subtab' => 'getFirewallInfoSubtab', 'api_docs_subtab' => 'getApiDocsSubtab', 'hardware_replacements_subtab' => 'getHardwareReplacementsSubtab', 'sm_forums' => 'getSmForums']

$setters

Array of attributes to setter functions (for deserialization of responses)

protected static array<string|int, string> $setters = ['help_tab' => 'setHelpTab', 'get_help_subtab' => 'setGetHelpSubtab', 'community_subtab' => 'setCommunitySubtab', 'cases_subtab' => 'setCasesSubtab', 'data_protection_requests_subtab' => 'setDataProtectionRequestsSubtab', 'get_help_subtab_knowledge_base_search' => 'setGetHelpSubtabKnowledgeBaseSearch', 'universal_search_knowledge_base_search' => 'setUniversalSearchKnowledgeBaseSearch', 'cisco_meraki_product_documentation' => 'setCiscoMerakiProductDocumentation', 'support_contact_info' => 'setSupportContactInfo', 'new_features_subtab' => 'setNewFeaturesSubtab', 'firewall_info_subtab' => 'setFirewallInfoSubtab', 'api_docs_subtab' => 'setApiDocsSubtab', 'hardware_replacements_subtab' => 'setHardwareReplacementsSubtab', 'sm_forums' => 'setSmForums']

$swaggerFormats

Array of property to format mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerFormats = ['help_tab' => null, 'get_help_subtab' => null, 'community_subtab' => null, 'cases_subtab' => null, 'data_protection_requests_subtab' => null, 'get_help_subtab_knowledge_base_search' => null, 'universal_search_knowledge_base_search' => null, 'cisco_meraki_product_documentation' => null, 'support_contact_info' => null, 'new_features_subtab' => null, 'firewall_info_subtab' => null, 'api_docs_subtab' => null, 'hardware_replacements_subtab' => null, 'sm_forums' => null]

$swaggerTypes

Array of property to type mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerTypes = ['help_tab' => 'string', 'get_help_subtab' => 'string', 'community_subtab' => 'string', 'cases_subtab' => 'string', 'data_protection_requests_subtab' => 'string', 'get_help_subtab_knowledge_base_search' => 'string', 'universal_search_knowledge_base_search' => 'string', 'cisco_meraki_product_documentation' => 'string', 'support_contact_info' => 'string', 'new_features_subtab' => 'string', 'firewall_info_subtab' => 'string', 'api_docs_subtab' => 'string', 'hardware_replacements_subtab' => 'string', 'sm_forums' => 'string']

Methods

setApiDocsSubtab()

Sets api_docs_subtab

public setApiDocsSubtab(string $api_docs_subtab) : $this
Parameters
$api_docs_subtab : string

The 'Help -> API docs' subtab where a detailed description of the Dashboard API is listed. Can be one of 'default or inherit', 'hide' or 'show'.

Return values
$this —

setCasesSubtab()

Sets cases_subtab

public setCasesSubtab(string $cases_subtab) : $this
Parameters
$cases_subtab : string

The 'Help -> Cases' Dashboard subtab on which Cisco Meraki support cases for this organization can be managed. Can be one of 'default or inherit', 'hide' or 'show'.

Return values
$this —

setCiscoMerakiProductDocumentation()

Sets cisco_meraki_product_documentation

public setCiscoMerakiProductDocumentation(string $cisco_meraki_product_documentation) : $this
Parameters
$cisco_meraki_product_documentation : string

The 'Product Manuals' section of the 'Help -> Get Help' subtab. Can be one of 'default or inherit', 'hide', 'show', or a replacement custom HTML string.

Return values
$this —

setCommunitySubtab()

Sets community_subtab

public setCommunitySubtab(string $community_subtab) : $this
Parameters
$community_subtab : string

The 'Help -> Community' subtab which provides a link to Meraki Community. Can be one of 'default or inherit', 'hide' or 'show'.

Return values
$this —

setDataProtectionRequestsSubtab()

Sets data_protection_requests_subtab

public setDataProtectionRequestsSubtab(string $data_protection_requests_subtab) : $this
Parameters
$data_protection_requests_subtab : string

The 'Help -> Data protection requests' Dashboard subtab on which requests to delete, restrict, or export end-user data can be audited. Can be one of 'default or inherit', 'hide' or 'show'.

Return values
$this —

setFirewallInfoSubtab()

Sets firewall_info_subtab

public setFirewallInfoSubtab(string $firewall_info_subtab) : $this
Parameters
$firewall_info_subtab : string

The 'Help -> Firewall info' subtab where necessary upstream firewall rules for communication to the Cisco Meraki cloud are listed. Can be one of 'default or inherit', 'hide' or 'show'.

Return values
$this —

setGetHelpSubtab()

Sets get_help_subtab

public setGetHelpSubtab(string $get_help_subtab) : $this
Parameters
$get_help_subtab : string

The 'Help -> Get Help' subtab on which Cisco Meraki KB, Product Manuals, and Support/Case Information are displayed. Note that if this subtab is hidden, branding customizations for the KB on 'Get help', Cisco Meraki product documentation, and support contact info will not be visible. Can be one of 'default or inherit', 'hide' or 'show'.

Return values
$this —

setGetHelpSubtabKnowledgeBaseSearch()

Sets get_help_subtab_knowledge_base_search

public setGetHelpSubtabKnowledgeBaseSearch(string $get_help_subtab_knowledge_base_search) : $this
Parameters
$get_help_subtab_knowledge_base_search : string

The KB search box which appears on the Help page. Can be one of 'default or inherit', 'hide', 'show', or a replacement custom HTML string.

Return values
$this —

setHardwareReplacementsSubtab()

Sets hardware_replacements_subtab

public setHardwareReplacementsSubtab(string $hardware_replacements_subtab) : $this
Parameters
$hardware_replacements_subtab : string

The 'Help -> Replacement info' subtab where important information regarding device replacements is detailed. Can be one of 'default or inherit', 'hide' or 'show'.

Return values
$this —

setHelpTab()

Sets help_tab

public setHelpTab(string $help_tab) : $this
Parameters
$help_tab : string

The Help tab, under which all support information resides. If this tab is hidden, no other 'Help' branding customizations will be visible. Can be one of 'default or inherit', 'hide' or 'show'.

Return values
$this —

setNewFeaturesSubtab()

Sets new_features_subtab

public setNewFeaturesSubtab(string $new_features_subtab) : $this
Parameters
$new_features_subtab : string

The 'Help -> New features' subtab where new Dashboard features are detailed. Can be one of 'default or inherit', 'hide' or 'show'.

Return values
$this —

setSmForums()

Sets sm_forums

public setSmForums(string $sm_forums) : $this
Parameters
$sm_forums : string

The 'SM Forums' subtab which links to community-based support for Cisco Meraki Systems Manager. Only configurable for organizations that contain Systems Manager networks. Can be one of 'default or inherit', 'hide' or 'show'.

Return values
$this —

setSupportContactInfo()

Sets support_contact_info

public setSupportContactInfo(string $support_contact_info) : $this
Parameters
$support_contact_info : string

The 'Contact Meraki Support' section of the 'Help -> Get Help' subtab. Can be one of 'default or inherit', 'hide', 'show', or a replacement custom HTML string.

Return values
$this —

setUniversalSearchKnowledgeBaseSearch()

Sets universal_search_knowledge_base_search

public setUniversalSearchKnowledgeBaseSearch(string $universal_search_knowledge_base_search) : $this
Parameters
$universal_search_knowledge_base_search : string

The universal search box always visible on Dashboard will, by default, present results from the Meraki KB. This configures whether these Meraki KB results should be returned. Can be one of 'default or inherit', 'hide' or 'show'.

Return values
$this —

Search results