Box Class Reference

Inheritance diagram for Box:

Collaboration diagram for Box:

Public Member Functions
_.Library.String	ContentURL ()
	The URL for uploading and downloading files.
_.Library.Status	MakeDownloadRequest (_.Library.String parameters, _.Library.BinaryStream body, _.Library.DynamicObject response)
	Make an Download style http request to Box API.
_.Library.Status	MakeRequest (_.Library.String method, _.Library.String parameters, _.Library.DynamicObject request, _.Library.String queryParameters, _.Library.DynamicObject response)
	Make an http request to Box API.
_.Library.Status	MakeUploadRequest (_.Library.String parameters, _.Library.String filename, _.Library.DynamicObject request, _.Library.BinaryStream body, _.Library.DynamicObject response)
	Make an upload http request to Box API.
_.Library.Status	RevokeToken ()
	Revoke the token associated with this connection. More...
Public Member Functions inherited from Base
_.Library.String	GetAuthorizationCodeURL (_.Library.String redirect, _.Library.String scope, _.Library.String properties, _.Library.Status sc)
	Get the URL for use by authorization code grant type.
_.Library.Boolean	IsAuthorized (_.Library.String errorMessage)
	Check if this connection has been authorized. More...
_.Library.Status	MakeHttpRequest (_.Net.HttpRequest httpRequest, _.Library.String method, _.Library.String url, _.Library.Boolean reset)
	MakeHttpRequest will add authentication to the specified Net.HttpRequest object and. More...
_.Library.Integer	OAuth2ClientCount ()
	Get count of connection which reference the specified OAuth 2.0 client.
_.Library.Status	Save ()
	The Save method saves a SYS.MFT.Connection.Base object. More...

Static Public Member Functions
_.Library.Status	CreateClient (_.Library.String name, _.Library.String sslConfiguration, _.Library.String clientId, _.Library.String clientSecret, _.Library.String issuer, _.Library.String host, _.Library.Integer port, _.Library.String prefix, _.Library.Boolean useSSL)
	Create an OAuth 2.0 client with the parameters required to authorize with Box. More...
_.Library.String	DefaultScope ()
	The default scope to use for obtaining the access token.
_.Library.String	DefaultURL ()
	Each subclass will define the DefaultURL method to supply the default URL for the service.
Static Public Member Functions inherited from Base
_.Library.Status	CreateClient (_.Library.String name, _.Library.String sslConfiguration, _.Library.String clientId, _.Library.String clientSecret, issuer, _.Library.String host, _.Library.Integer port, _.Library.String prefix, _.Library.Boolean useSSL)
	Create an OAuth 2.0 client with the parameters required to authorize. More...
_.Library.Status	DeleteId (_.Library.String name, _.Library.Boolean keepOAuth2)
	The DeleteId method deletes an existing connection object specified by its name. More...
_.SYS.MFT.Connection.Base	Open (_.Library.String name, _.Library.Status sc)
	Open a SYS.MFT.Connection.Base subclass instance based on the ConnectionName property.

Additional Inherited Members
Public Attributes inherited from Base
	ApplicationName
	ApplicationName is the OAuth2 application name associated with this connection. More...
	HttpRequest
	Use the same Net.HttpRequest object for all requests in the same session. More...
	Name
	Name is the name of this connection to a file management service. More...
	SSLConfiguration
	SSLConfiguration is the name of the SSL Configuration to be used to communicate with the file management API. More...
	Service
	Service is the name of the service that is accessed by this connection. More...
	URL
	URL is the base URL for REST access to this service including the final /. More...
	Username
	Username is the name of the user on whose behalf the file access will take place. More...

Member Function Documentation

CreateClient()

_.Library.Status CreateClient ( _.Library.String  name, _.Library.String  sslConfiguration, _.Library.String  clientId, _.Library.String  clientSecret, _.Library.String  issuer, _.Library.String  host, _.Library.Integer  port, _.Library.String  prefix, _.Library.Boolean  useSSL  )

static

Create an OAuth 2.0 client with the parameters required to authorize with Box.

name is the name to be given to the OAuth 2.0 client.
sslConfiguration is the SSLConfiguration used to make the HTTP request.
clientId and ClientSecret are the id and secret for the OAuth 2.0 client which is obtained from the Box App definition.
If addiitonal properties are needed, then the Dropbox OAuth 2.0 client may be opened and modified.
If a server definition does not yet exist for Dropbox, then a new server definition is created.

RevokeToken()

_.Library.Status RevokeToken

(

)

Revoke the token associated with this connection.

Revoke the token in Box as well as locally.

Reimplemented from Base.