Oihana uses AuditTrait, AuthTrait, LogTrait, PaginationTrait, SiteTrait
Table of Contents
Constants
- DATE : string = 'date'
- The attribute key of the 'date' property.
- DELIVERY_METHOD : string = 'deliveryMethod'
- EVENT : string = 'event'
- The audit event tag (e.g. `role.created`, `user.deleted`).
- IP : string = 'ip'
- The IP address of the client that performed the action.
- LEVEL : string = 'level'
- The attribute key of the 'level' property.
- LIMIT : string = 'limit'
- The attribute key for the 'limit' property.
- MAX_LIMIT : string = 'maxLimit'
- The attribute key for the 'maxLimit' property.
- MESSAGE : string = 'message'
- The attribute key of the 'message' property.
- METHOD : string = 'method'
- The HTTP method used (POST, PATCH, PUT, DELETE).
- MIN_LIMIT : string = 'minLimit'
- The attribute key for the 'minLimit' property.
- NUMBER_OF_PAGES : string = 'numberOfPages'
- The attribute key for the 'numberOfPages' property.
- OFFSET : string = 'offset'
- The attribute key for the 'offset' property.
- OUTCOME : string = 'outcome'
- The machine-readable outcome of the action (e.g. `success`, `denied`, `error`).
- OWNED_BY : string = 'ownedBy'
- PAGE : string = 'page'
- The attribute key for the 'page' property.
- PATH : string = 'path'
- The full request path (e.g. `/roles/42`).
- POSITION : string = 'position'
- RESOURCE : string = 'resource'
- The resource collection name (e.g. `roles`, `users`, `permissions`).
- RESOURCE_ID : string = 'resourceId'
- The `_key` of the targeted document in the resource collection.
- SCHEMA : string = 'https://schema.oihana.xyz'
- The default oihana schema.
- STATUS_CODE : string = 'statusCode'
- The HTTP status code of the response.
- TIME : string = 'time'
- The attribute key of the 'time' property.
Constants
DATE
The attribute key of the 'date' property.
public
string
DATE
= 'date'
DELIVERY_METHOD
public
string
DELIVERY_METHOD
= 'deliveryMethod'
EVENT
The audit event tag (e.g. `role.created`, `user.deleted`).
public
string
EVENT
= 'event'
IP
The IP address of the client that performed the action.
public
string
IP
= 'ip'
LEVEL
The attribute key of the 'level' property.
public
string
LEVEL
= 'level'
LIMIT
The attribute key for the 'limit' property.
public
string
LIMIT
= 'limit'
Used to identify the maximum number of items to return per page in an array, JSON, or other structured representation.
MAX_LIMIT
The attribute key for the 'maxLimit' property.
public
string
MAX_LIMIT
= 'maxLimit'
Represents the upper bound on the number of items that can be requested per page.
MESSAGE
The attribute key of the 'message' property.
public
string
MESSAGE
= 'message'
METHOD
The HTTP method used (POST, PATCH, PUT, DELETE).
public
string
METHOD
= 'method'
MIN_LIMIT
The attribute key for the 'minLimit' property.
public
string
MIN_LIMIT
= 'minLimit'
Represents the lower bound on the number of items that can be requested per page.
NUMBER_OF_PAGES
The attribute key for the 'numberOfPages' property.
public
string
NUMBER_OF_PAGES
= 'numberOfPages'
Represents the total number of pages in the paginated collection. Can be used to generate pagination controls or metadata.
OFFSET
The attribute key for the 'offset' property.
public
string
OFFSET
= 'offset'
Indicates the number of items to skip before starting to collect the result set.
OUTCOME
The machine-readable outcome of the action (e.g. `success`, `denied`, `error`).
public
string
OUTCOME
= 'outcome'
OWNED_BY
public
string
OWNED_BY
= 'ownedBy'
PAGE
The attribute key for the 'page' property.
public
string
PAGE
= 'page'
Indicates the current page number in the paginated collection.
PATH
The full request path (e.g. `/roles/42`).
public
string
PATH
= 'path'
POSITION
public
string
POSITION
= 'position'
RESOURCE
The resource collection name (e.g. `roles`, `users`, `permissions`).
public
string
RESOURCE
= 'resource'
RESOURCE_ID
The `_key` of the targeted document in the resource collection.
public
string
RESOURCE_ID
= 'resourceId'
SCHEMA
The default oihana schema.
public
string
SCHEMA
= 'https://schema.oihana.xyz'
STATUS_CODE
The HTTP status code of the response.
public
string
STATUS_CODE
= 'statusCode'
TIME
The attribute key of the 'time' property.
public
string
TIME
= 'time'