Module: X::ClientCredentials Private

Included in:
Client
Defined in:
lib/x/client_credentials.rb

Overview

This module is part of a private API. You should avoid using this module if possible, as it may be removed or be changed in the future.

Mixin for client authentication credentials

Instance Attribute Summary collapse

Instance Attribute Details

#access_token ⇒ String?

The access token for OAuth authentication

Examples:

Get the access token

client.access_token

Returns:

  • (String, nil) —

    the access token for OAuth authentication



24
25
26
 
# File 'lib/x/client_credentials.rb', line 24

def access_token
  @access_token
end

#access_token_secret ⇒ String?

The access token secret for OAuth 1.0a authentication

Examples:

Get the access token secret

client.access_token_secret

Returns:

  • (String, nil) —

    the access token secret for OAuth 1.0a authentication



31
32
33
 
# File 'lib/x/client_credentials.rb', line 31

def access_token_secret
  @access_token_secret
end

#api_key ⇒ String?

The API key for OAuth 1.0a authentication

Examples:

Get the API key

client.api_key

Returns:

  • (String, nil) —

    the API key for OAuth 1.0a authentication



10
11
12
 
# File 'lib/x/client_credentials.rb', line 10

def api_key
  @api_key
end

#api_key_secret ⇒ String?

The API key secret for OAuth 1.0a authentication

Examples:

Get the API key secret

client.api_key_secret

Returns:

  • (String, nil) —

    the API key secret for OAuth 1.0a authentication



17
18
19
 
# File 'lib/x/client_credentials.rb', line 17

def api_key_secret
  @api_key_secret
end

#bearer_token ⇒ String?

The bearer token for authentication

Examples:

Get the bearer token

client.bearer_token

Returns:

  • (String, nil) —

    the bearer token for authentication



38
39
40
 
# File 'lib/x/client_credentials.rb', line 38

def bearer_token
  @bearer_token
end

#client_id ⇒ String?

The OAuth 2.0 client ID

Examples:

Get the client ID

client.client_id

Returns:

  • (String, nil) —

    the OAuth 2.0 client ID



45
46
47
 
# File 'lib/x/client_credentials.rb', line 45

def client_id
  @client_id
end

#client_secret ⇒ String?

The OAuth 2.0 client secret

Examples:

Get the client secret

client.client_secret

Returns:

  • (String, nil) —

    the OAuth 2.0 client secret



52
53
54
 
# File 'lib/x/client_credentials.rb', line 52

def client_secret
  @client_secret
end

#refresh_token ⇒ String?

The OAuth 2.0 refresh token

Examples:

Get the refresh token

client.refresh_token

Returns:

  • (String, nil) —

    the OAuth 2.0 refresh token



59
60
61
 
# File 'lib/x/client_credentials.rb', line 59

def refresh_token
  @refresh_token
end