%SYS.MFT.Connection.Box

persistent class %SYS.MFT.Connection.Box extends %SYS.MFT.Connection.Base

SQL Table Name: %SYS_MFT_Connection.Box

Method Inventory

Methods

method ContentURL() as %String [ Language = objectscript ]
The URL for uploading and downloading files.
classmethod CreateClient(name As %String, sslConfiguration As %String, clientId As %String, clientSecret As %String, issuer As %String = "https://account.box.com", host As %String = "localhost", port As %Integer = "", prefix As %String = "", useSSL As %Boolean = 1) as %Status [ Language = objectscript ]
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.
classmethod DefaultScope() as %String [ Language = objectscript ]
The default scope to use for obtaining the access token.
classmethod DefaultURL() as %String [ Language = objectscript ]
Each subclass will define the DefaultURL method to supply the default URL for the service.
method MakeDownloadRequest(parameters As %String, body As %BinaryStream, Output response As %DynamicObject) as %Status [ Language = objectscript ]
Make an Download style http request to Box API
method MakeRequest(method As %String, parameters As %String, request As %DynamicObject = "", ByRef queryParameters As %String, Output response As %DynamicObject) as %Status [ Language = objectscript ]
Make an http request to Box API
method MakeUploadRequest(parameters As %String, filename As %String, request As %DynamicObject = "", body As %BinaryStream, Output response As %DynamicObject) as %Status [ Language = objectscript ]
Make an upload http request to Box API
method RevokeToken() as %Status [ Language = objectscript ]
Revoke the token associated with this connection. Revoke the token in Box as well as locally.

Inherited Members

Inherited Properties

Inherited Methods

Storage

Gray indicates storage defined by superclasses.

Storage Model: Storage (%SYS.MFT.Connection.Base)

^|"^^"_$zu(12)|SYS("Security","MFTConnectionD")(ID)
=
%%CLASSNAME

Storage Model: Storage (%SYS.MFT.Connection.Base)

^|"^^"_$zu(12)|SYS("Security","MFTConnectionD")(ID,"1")
=
Name
Service
URL
SSLConfiguration
Username
ApplicationName
Id
PublicKeyFilename
PrivateKey
ConnectionId
CurrentFolder
Feedback