@rocket.chat/apps-engine
Version:
The engine code for the Rocket.Chat Apps which manages, runs, translates, coordinates and all of that.
43 lines • 1.96 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.ApiSecurity = exports.ApiVisibility = void 0;
var ApiVisibility;
(function (ApiVisibility) {
/**
* A public Api has a fixed format for a url. Using it enables an
* easy to remember structure, however, it also means the url is
* intelligently guessed. As a result, we recommend having some
* sort of security setup if you must have a public api.Whether
* you use the provided security, ApiSecurity, or implement your own.
* Url format:
* `https://{your-server-address}/api/apps/public/{your-app-id}/{path}`
*/
ApiVisibility[ApiVisibility["PUBLIC"] = 0] = "PUBLIC";
/**
* Private Api's contain a random value in the url format,
* making them harder go guess by default. The random value
* will be generated whenever the App is installed on a server.
* This means that the URL will not be the same on any server,
* but will remain the same throughout the lifecycle of an App
* including updates. As a result, if a user uninstalls the App
* and reinstalls the App, then the random value will change.
* Url format:
* `https://{your-server-address}/api/apps/private/{your-app-id}/{random-hash}/{path}`
*/
ApiVisibility[ApiVisibility["PRIVATE"] = 1] = "PRIVATE";
})(ApiVisibility || (exports.ApiVisibility = ApiVisibility = {}));
var ApiSecurity;
(function (ApiSecurity) {
/**
* No security check will be executed agains the calls made to this URL
*/
ApiSecurity[ApiSecurity["UNSECURE"] = 0] = "UNSECURE";
/**
* Only calls containing a valid token will be able to execute the api
* Mutiple tokens can be generated to access the api, by default one
* will be generated automatically.
* @param `X-Auth-Token`
*/
// CHECKSUM_SECRET,
})(ApiSecurity || (exports.ApiSecurity = ApiSecurity = {}));
//# sourceMappingURL=IApi.js.map