Class: Jamf::OAPISchemas::SessionStatus

Inherits:

Jamf::OAPIObject

Object
Jamf::OAPIObject
Jamf::OAPISchemas::SessionStatus

show all

Defined in:: lib/jamf/api/jamf_pro/oapi_schemas/session_status.rb

Overview

OAPI Object Model and Enums for: SessionStatus

Description of this class from the OAPI Schema:

Session status

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.

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.

- '/preview/remote-administration-configurations/team-viewer/{configurationId}/sessions/{sessionId}/status:GET' needs permissions:
  - Read Remote Administration

Constant Summary collapse

SESSION_STATE_OPTIONS = Enums used by this class or others

[
  'OPEN',
  'CLOSED',
  'UNKNOWN'
]

OAPI_PROPERTIES =

{

  # Session state
  # @!attribute sessionState
  #   @return [String]
  sessionState: {
    class: :string,
    enum: SESSION_STATE_OPTIONS
  },

  # Defines if the end user is online
  # @!attribute online
  #   @return [Boolean]
  online: {
    class: :boolean
  }

}

Instance Attribute Summary collapse

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#online ⇒ `Boolean`

Returns:

(Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/session_status.rb', line 85

#sessionState ⇒ `String`