TTMSFNCCloudSentry
Usage
TTMSFNCCloudSentry is a component that provides access to the Sentry API which is capable of managing exceptions and log messages.
Authorization information
Authentication token (via ‘Account’ > ‘API’).
Remark
When used on TMS WEB Core, CORS issues may arise with the message ‘Origin is invalid’. This can be fixed by createing an integration in the ‘Settings’ of the project in ‘Developer Settings’. Use the token on that page.
Properties
| Property name | Description |
|---|---|
| AuthenticationToken: String | The authentication token of the user with the necessary scopes. |
| Projects: TTMSFNCCloudSentryProjects [TTMSFNCCloudSentryProject] | Contains the different projects that you have set up in Sentry. These projects each have different issues (TTMSFNCCloudSentryIssues) in the property Issues. This is a group of exceptions and messages with the same parameters and can be requested in the same way as the Projects on TTMSFNCCloudSentryProject level. These issues in turn have the property Events (TTMSFNCCloudSentryEvents), which is a collection of the exceptions and messages and can be retrieved in the same way on TTMSFNCCloudSentryIssue level. |
| ProjectCursor: String | The cursor to add to the GetProjects method to retrieve the following projects. |
Methods
| Method name | Description |
|---|---|
| Connect | Checks if the authentication token is valid. (Has the possibility to add an authentication token as a parameter in case this was not set via the property.) |
| GetProjects/GetAllProjects | Retrieve (all) the projects for the account. The procedure fills the Projects (TTMSFNCCloudSentryProjects) property. |
| GetProjectByID | Retrieve the TTMSFNCCloudSentryProject object that has the requested ID. |
| GetProjectByName | Retrieve the TTMSFNCCloudSentryProject object that has the requested name. |
| GetIssueByID | Retrieve the TTMSFNCCloudSentryIssue object that has the requested ID. |
| LogException | Sends an exception to the project with a message, an error type and source. Can be extended with an optional stacktrace, level, timestamp and value. (It is necessary to retrieve the requested project first via GetProjects/GetAllProjects.) |
| LogMessage | Sends a message to the project. Can be extended with an optional level, timestamp, source and stacktrace. (It is necessary to retrieve the requested project first via GetProjects/GetAllProjects.) |
Events
| Event name | Description |
|---|---|
| OnConnected | Event fired when the authorization token is valid. |
| OnGetProjects/OnGetAllProjects | Event fired when the/all requested projects for the account are retrieved. This event returns additional to the sender and the request result also the Projects (TTMSFNCCloudSentryProjects). |
| OnGetIssues/OnGetAllIssues | Event fired when the/all requested issues from a project are retrieved. This event returns additional to the sender and the request result also the project (TTMSFNCCloudSentryProject) for which it was returned and the list of issues (TTMSFNCCloudSentryIssues). |
| OnGetEvents/OnGetAllEvents | Event fired when the requested events for an issue are retrieved. This event returns additional to the sender and the request result also the issue of the project (TTMSFNCCloudSentryIssue) and the requested events (TTMSFNCCLoudSentryEvents). |
| OnLogException | Event fired when the created exception is sent to the project. This event returns the sender, the event ID and the request result. |
| OnLogMessage | Event fired when the created exception is sent to the project. This event returns the sender, the event ID and the request result. |