Skip to contents

Class containing UNIFI API connection parameters

Source: R/api_connection.R
connection_params-class.Rd

Contains url and token for connection to UNIFI API.

Usage

# S4 method for class 'connection_params'
connection_apihosturl(obj)

# S4 method for class 'connection_params'
connection_token(obj)

# S4 method for class 'connection_params'
connection_identityurl(obj)

# S4 method for class 'connection_params'
connection_username(obj)

# S4 method for class 'connection_params'
connection_password(obj)

Arguments

obj

The connection_params object to access.

Value

connection_apihosturl returns a character object containing the connection url.

connection_token returns a character object containing the connection token.

connection_identityurl returns a character object containing the connection identity url.

connection_username returns a character object containing the connection username.

connection_password returns a character object containing the connection password.

Details

Objects for this class are returned by create_connection_params.

Methods (by generic)

  • connection_apihosturl(connection_params): Accessor method to obtain the connection url.

  • connection_token(connection_params): Accessor method to obtain the connection token.

  • connection_identityurl(connection_params): Accessor method to obtain the connection token.

  • connection_username(connection_params): Accessor method to obtain the connection username.

  • connection_password(connection_params): Accessor method to obtain the connection password.

Slots

identityurl

Contains a character with the URL for connection to the UNIFI identity server.

username

Contains a character with the user name for connection to the UNIFI identity server (e.g. administrator).

password

Contains a character with the user password for connection to the UNIFI identity server (e.g. administrator).

apihosturl

Contains a character with the URL for connection to the UNIFI API server (host).

token

A character with the token sent back from the UNIFI API.

Use the create_connection_params to

store the connection parameters, using the default parameters or replacing them with the needed URLs, username and password to the UNIFI API. It will request a connection token that will be used by other functions to retrieve data.