Class: OBS::WebSocket::Protocol::Responses::GetAuthRequired

Inherits:

OBS::WebSocket::Protocol::Response

• Object
• ServerMessage
• OBS::WebSocket::Protocol::Response
• OBS::WebSocket::Protocol::Responses::GetAuthRequired

Defined in:

lib/obs/websocket/protocol.rb

Overview

See Also:

• OBS::WebSocket::Protocol::Requests::GetAuthRequired
• https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getauthrequired

Instance Attribute Summary

• #auth_required ⇒ Boolean readonly

  authRequired field.

• #challenge ⇒ String^? readonly

  challenge field.

• #salt ⇒ String^? readonly

  salt field.

Method Summary

Methods inherited from OBS::WebSocket::Protocol::Response

#initialize, #to_h

Constructor Details

This class inherits a constructor from OBS::WebSocket::Protocol::Response

Instance Attribute Details

#auth_required ⇒ Boolean (readonly)

Returns authRequired field.

Returns:

• (Boolean) —

  authRequired field

# File 'lib/obs/websocket/protocol.rb', line 3446

def auth_required; get_field("authRequired", Types::Boolean); end

#challenge ⇒ String^? (readonly)

Returns challenge field.

Returns:

• (String, nil) —

  challenge field

# File 'lib/obs/websocket/protocol.rb', line 3449

def challenge; get_field("challenge", Types::Optional[Types::String]); end

#salt ⇒ String^? (readonly)

Returns salt field.

Returns:

• (String, nil) —

  salt field

# File 'lib/obs/websocket/protocol.rb', line 3452

def salt; get_field("salt", Types::Optional[Types::String]); end