|
ContentBox Core API 1.6.0 | ||||
FRAMES |
WEB-INF.cftags.componentcontentbox.model.updates.ForgeBox
public class ForgeBox
ForgeBox API REST Wrapper
Property Summary | ||||
---|---|---|---|---|
Type | Property & Description | Default | Serializable | Required |
any
|
APIURL
Attributes:
|
|
true
|
false
|
any
|
logger
Attributes:
|
|
true
|
false
|
Constructor Summary | |
---|---|
init()
Constructor |
Method Summary | |
---|---|
void |
$abort()
Facade for cfabort |
void |
$dump(any var, [boolean isAbort='false'])
Facade for cfmx dump |
any |
$throw(string message, [string detail=''], [string type='Framework'])
Facade for cfthrow |
any |
GETAPIURL()
get: |
any |
GETLOGGER()
get: |
ForgeBox |
SETAPIURL(any APIURL)
set: |
ForgeBox |
SETLOGGER(any logger)
set: |
query |
getEntries([string orderBy='[runtime expression]'], [numeric maxrows='0'], [numeric startRow='1'], [string typeSlug=''])
Get entries |
struct |
getEntry(string slug='')
Get an entry from forgebox by slug |
query |
getTypes()
Get an array of entry types |
struct |
install(string downloadURL, string destinationDir)
Install Code Entry |
private struct |
makeRequest([string method='GET'], [string resource=''], [any body=''], [struct headers='[runtime expression]'], [struct parameters='[runtime expression]'], [numeric timeout='30'])
Invoke a ForgeBox REST Call |
Methods inherited from class WEB-INF.cftags.component |
---|
None
|
Constructor Detail |
---|
public init()
Property Detail |
---|
any APIURL
inject
- coldbox:setting:updatesURL@contentboxrequired
- falseserializable
- truedefault
- any logger
inject
- logbox:logger:{this}required
- falseserializable
- truedefault
- Method Detail |
---|
public void $abort()
public void $dump(any var, [boolean isAbort='false'])
var
isAbort
- Abort alsopublic any $throw(string message, [string detail=''], [string type='Framework'])
message
detail
type
public any GETAPIURL()
public any GETLOGGER()
public ForgeBox SETAPIURL(any APIURL)
APIURL
public ForgeBox SETLOGGER(any logger)
logger
public query getEntries([string orderBy='[runtime expression]'], [numeric maxrows='0'], [numeric startRow='1'], [string typeSlug=''])
orderBy
- The type to order by, look at this.ORDERBYmaxrows
- Max rows to returnstartRow
- StartRowtypeSlug
- The tye slug to filter onpublic struct getEntry(string slug='')
slug
- The entry slug to retreivepublic query getTypes()
public struct install(string downloadURL, string destinationDir)
downloadURL
destinationDir
private struct makeRequest([string method='GET'], [string resource=''], [any body=''], [struct headers='[runtime expression]'], [struct parameters='[runtime expression]'], [numeric timeout='30'])
method
- The HTTP method to invokeresource
- The resource to hit in the forgebox service.body
- The body content of the request if passed.headers
- An struct of HTTP headers to sendparameters
- An struct of HTTP URL parameters to send in the requesttimeout
- The default call timeout
|
ContentBox Core API 1.6.0 | ||||
FRAMES |