lucee.Component
forgeboxsdk.ForgeBox
Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com ---
| Property Summary | ||||
|---|---|---|---|---|
| type | property | default | serializable | required |
any
|
endpointURL
The ForgeBox Endpoint URL.
|
true
|
false
|
|
any
|
version
The ForgeBox API version to use.
|
1
|
true
|
false
|
| Constructor Summary | |
|---|---|
|
init([any endpointURL='https://www.forgebox.io'], [any version='v1'])
Constructor. |
|
| Method Summary | |
|---|---|
any
|
getAPIURL()
Gets the API URL according to properties: ex: https://www. |
string
|
getEndpointURL()
|
struct
|
getEntries([any orderBy='[runtime expression]'], [numeric maxrows='0'], [numeric startRow='1'], [any typeslug=''], [any searchTerm=''])
Get entries. |
struct
|
getEntry(any slug)
Get a single entry data. |
struct
|
getLatestVersion(any slug)
Get an entry's latest version. |
struct
|
getType(any slug)
Get a type representation. |
array
|
getTypes()
Get the entry types as array of structs. |
string
|
getVersion()
|
boolean
|
isSlugAvailable(any slug)
Check if a slug is available. |
private struct
|
makeRequest([string method='GET'], string resource, [any body=''], [struct headers='[runtime expression]'], [struct parameters='[runtime expression]'], [numeric timeout='15'])
Make a ForgeBox REST Call. |
string
|
ping()
Pings the API to see if its alive. |
any
|
setEndpointURL(any endpointURL)
|
any
|
setVersion(any version)
|
| Methods inherited from class lucee.Component |
|---|
| None |
| Constructor Detail |
|---|
Constructor
endpointURL - Override the Forgebox Endpoint URLversion - Override the version to use, defaults to latest: v1| Property Detail |
|---|
The ForgeBox Endpoint URL
access - publicrequired - falsereturntype - anyserializable - trueThe ForgeBox API version to use
access - publicrequired - falsereturntype - anyserializable - true| Method Detail |
|---|
Gets the API URL according to properties: ex: https://www.forgebox.io/api/v1
Get entries
orderBy - The sort ordering, look at this.ORDERmaxrows - Used for paginationstartRow - Used for paginationtypeslug - Filter by typesearchTerm - Search by stringGet a single entry data
slug - The slug to retrieveGet an entry's latest version
slug - The slug to retrieveGet a type representation
slugGet the entry types as array of structs
Check if a slug is available
slugMake a ForgeBox REST Call
method - The HTTP method callresource - The resource to callbody - The body contents of the requestheaders - Request headersparameterstimeout - Request TimeoutPings the API to see if its alive
endpointURLversion