BrightcoveAPIClientInterface.php in Brightcove Video Connect 8.2
Same filename and directory in other branches
Namespace
Drupal\brightcoveFile
src/BrightcoveAPIClientInterface.phpView source
<?php
namespace Drupal\brightcove;
use Drupal\Core\Config\Entity\ConfigEntityInterface;
/**
* Provides an interface for defining Brightcove API Client entities.
*/
interface BrightcoveAPIClientInterface extends ConfigEntityInterface {
/**
* Indicates the default player for any API Client.
*/
const DEFAULT_PLAYER = 'default';
/**
* Indicates that the connection to the API was not successful.
*/
const CLIENT_ERROR = 0;
/**
* Indicates that the connection to the API was successful.
*/
const CLIENT_OK = 1;
/**
* Returns the API Client label.
*
* @return string
* The label for this API Client.
*/
public function getLabel();
/**
* Returns the API Client account ID.
*
* @return string
* The account ID for this API Client.
*/
public function getAccountId();
/**
* Returns the API Client ID.
*
* @return string
* The client ID for this API Client.
*/
public function getClientId();
/**
* Returns the API Client default player.
*
* @return string
* The default player for this API Client.
*/
public function getDefaultPlayer();
/**
* Returns the API Client secret key.
*
* @return string
* The secret key for this API Client.
*/
public function getSecretKey();
/**
* Returns the loaded API client.
*
* @return \Brightcove\API\Client
* Loaded API client.
*/
public function getClient();
/**
* Returns the connection status.
*
* @return int
* Possible values:
* - CLIENT_OK
* - CLIENT_ERROR
*/
public function getClientStatus();
/**
* Returns the connection status message.
*
* @return string
* The connection status message.
*/
public function getClientStatusMessage();
/**
* Returns access token.
*
* @return string
* The access token.
*/
public function getAccessToken();
/**
* Returns the maximum number of addable custom fields.
*
* @return int
* The maximum number of addable custom fields.
*/
public function getMaxCustomFields();
/**
* Sets the API Client label.
*
* @param string $label
* The desired label.
*
* @return $this
*/
public function setLabel($label);
/**
* Sets the API Client account ID.
*
* @param string $account_id
* The desired account ID.
*
* @return $this
*/
public function setAccountId($account_id);
/**
* Sets the API Client ID.
*
* @param string $client_id
* The desired client ID.
*
* @return $this
*/
public function setClientId($client_id);
/**
* Sets the API Client default player.
*
* @param string $default_player
* The desired default player.
*
* @return $this
*/
public function setDefaultPlayer($default_player);
/**
* Sets the API Client secret key.
*
* @param string $secret_key
* The desired secret key.
*
* @return $this
*/
public function setSecretKey($secret_key);
/**
* Sets access token.
*
* @param string $access_token
* The access token.
* @param int $expire
* The time for which the token is valid in seconds.
*
* @return $this
*/
public function setAccessToken($access_token, $expire);
/**
* Sets the maximum addable custom fields number.
*
* @param int $max_custom_fields
* The maximum custom fields number.
*
* @return $this
*/
public function setMaxCustomFields($max_custom_fields);
}
Interfaces
Name | Description |
---|---|
BrightcoveAPIClientInterface | Provides an interface for defining Brightcove API Client entities. |