TTMSFNCCloudRollbar
Usage
TTMSFNCCloudRollbar
is a component that provides access to the Rollbar API which is capable of managing exceptions and log messages.
Account authentication token with read scopes (via ‘Settings’ > ‘Account Access Tokens’
).
It is also necessary to make a project access token available with the post_client_item scope if you want to log messages and exceptions (via ‘Settings’ > ‘Project Access Tokens’
).
Organisation
Properties
Property name |
Description |
AccountTokenRead: String |
The account authentication token of the user with the necessary scopes. |
Projects: TTMSFNCCloudRollbarProjects [TTMSFNCCloudRollbarProject] |
Contains the different projects that you have set up in Rollbar . These projects each have different items (TTMSFNCCloudRollbarItem ) in the collection Items. This is a group of exceptions and messages with the same parameters and can be requested in the same way as the Projects on TTMSFNCCloudRollbarProject level. These issues in turn have the property Occurences (TTMSFNCCloudRollbarOccurences ), which is a collection of the exceptions and messages and can be retrieved in the same way on TTMSFNCCloudRollbarItem 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 (TTMSFNCCloudRollbarProjects ) property. |
GetProjectByID |
Retrieve the TTMSFNCCloudRollbarProject object that has the requested ID. |
GetProjectByName |
Retrieve the TTMSFNCCloudRollbarProject object that has the requested name. |
GetItemByID |
Retrieve the TTMSFNCCloudRollbarItem 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, description and environment which is by default set to ‘production’. (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 environment which is by default set to ‘production’. (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 (TTMSFNCCloudRollbarProjects ) and a possible error message. |
OnGetItems/OnGetAllItems |
Event fired when the/all requested items from a project are retrieved. This event returns additional to the sender and the request result also the project (TTMSFNCCloudRollbarProject ) for which it was returned, the list of items (TTMSFNCCloudRollbarItems ) and a possible error message. |
OnGetOccurences/OnGetAllOccurences |
Event fired when the requested occurences for an item are retrieved. This event returns additional to the sender and the request result also the item of the project (TTMSFNCCloudRollbarItem ), the requested occurences (TTMSFNCCloudRollbarOccurences ) and a possible error message. |
OnLogException |
Event fired when the created exception is sent to the project. This event returns the sender, the project (TTMSFNCCloudRollbarProject ), a possible error message and the request result. |
OnLogMessage |
Event fired when the created message is sent to the project. This event returns the sender, the project (TTMSFNCCloudRollbarProject ), a possible error message and the request result. |