railo-context.Componentcontentbox.model.updates.ForgeBox
ForgeBox API REST Wrapper
Property Summary | ||||
---|---|---|---|---|
type | property | default | serializable | required |
any
|
APIURL
|
true
|
false
|
|
any
|
logger
|
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. |
string
|
getAPIURL()
|
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. |
string
|
getLogger()
|
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. |
any
|
setAPIURL(any APIURL)
|
any
|
setLogger(any logger)
|
Methods inherited from class railo-context.Component |
---|
None |
Constructor Detail |
---|
Constructor
Property Detail |
---|
required
- falseinject
- coldbox:setting:updatesURL@contentboxserializable
- truerequired
- falseinject
- logbox:logger:{this}serializable
- trueMethod Detail |
---|
Facade for cfabort
Facade for cfmx dump
var
isAbort
- Abort alsoFacade for cfthrow
message
detail
type
Get entries
orderBy
- The type to order by, look at this.ORDERBYmaxrows
- Max rows to returnstartRow
- StartRowtypeSlug
- The tye slug to filter onGet an entry from forgebox by slug
slug
- The entry slug to retreiveGet an array of entry types
Install Code Entry
downloadURL
destinationDir
Invoke a ForgeBox REST Call
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 timeoutAPIURL
logger