commandbox.system.endpoints

Interface IEndpoint

commandbox.system.endpoints.IEndpoint
All Known Implementing Classes:
CFLib , CFLib-ColdBox , File , Folder , Gist , Git , Git_HTTP , Git_HTTPS , Git_SSH , Github , HTTP , HTTPS , HTTPS_Cached , HTTP_Cached , Jar , Java , Lex , S3 , TempFile
All Known Subinterfaces:
IEndpointInteractive

Copyright Since 2014 CommandBox by Ortus Solutions, Corp www.coldbox.org | www.ortussolutions.com I am an endpoint. I can retreive packages for you.

Class Attributes:
  • author : Brad Wood, Luis Majano, Denny Valliant
    •  
    Method Summary
    any getDefaultName(string package)
         Determines the name of a package based on its ID if there is no box.
    any getUpdate(string package, string version, [boolean verbose])
         Checks to see if there is an update to the package.
    string resolvePackage(string package, [boolean verbose])
         Accepts the name of a package, retrieves it, and returns a local folder path where the package is.
    Method Detail

    getDefaultName

    public any getDefaultName(string package)

    Determines the name of a package based on its ID if there is no box.json

    Parameters:
    package

    getUpdate

    public any getUpdate(string package, string version, [boolean verbose])

    Checks to see if there is an update to the package is outdated as well as the newly available version. The default return struct is this: { isOutdated = false, version = '' }

    Parameters:
    package
    version
    verbose

    resolvePackage

    public string resolvePackage(string package, [boolean verbose])

    Accepts the name of a package, retrieves it, and returns a local folder path where the package is

    Parameters:
    package
    verbose