Namespace Glitch9.IO.Networking.RESTApi
Classes
- ApiEnumConverter
Custom JsonConverter for API enum values.
- CRUDClient<TSelf>
REST API client for performing CRUD operations.
- CRUDServiceBase<TClient>
Base class for CRUD services, providing common properties and methods. If the service requires something that does not fit CRUDService<TClient, TData, TRequest, Tquery>, inherit from this class and implement the required methods.
- CRUDService<TClient, TData, TRequest, Tquery>
CRUDServiceis a generic base class for performing standard CRUD operations against a RESTful API. It provides methods to create, retrieve, update, delete, and list resources on the server using a specified endpoint.If a specific operation is not needed, use object as a placeholder for the corresponding generic type. For example, if query options are not required, use
objectforTquery.
- QueryCursor
A cursor for use in pagination.
- RESTApiV3
Utility class for sending REST API requests and handling responses. This class doesn't have 'Util' suffix since it's more important than RESTClient itself.
- RESTClient
A REST client class for handling various types of REST API requests.
- RESTClientSettings
Added 2025.04.15 to handle more setting properties for the RESTClient. This class is used to configure the RESTClient settings.
- RESTRequest
This class is used to create a http request. It holds the endpoint, headers, form data and the request options. It is used to send a request to the server and receive a response.
- RESTRequest<T>
This class is used to create a http request. It holds the endpoint, headers, form data and the request options.
- RESTResponse
The base class for all API objects returned by RESTApiV3. This class encapsulates common properties and methods for handling various types of outputs from REST API responses.
- RequestOptions
Options for RESTRequest and RESTRequest<T>. This class is used to set the parameters for the http request.
- RouteBuilder
Provides methods to manage Firestore document and collection references dynamically.
- StringOr<T>
This object can be either a string, T, or an array of T.
- SystemLanguageISOConverter
Custom JsonConverter for converting SystemLanguage to and from its ISO code.
Structs
- UpdateMask
This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".
Interfaces
Enums
- CRUDMethod
CRUD is abbreviation for Create, Read, Update, Delete. It is used to define the operations that can be performed on a REST resource.
- DataTransferMode
Data transfer mode for RESTApiV3.
- SSEField
Server-Sent Event field keys.
Delegates
- CRUDClient<TSelf>.ExceptionHandler
Delegate for handling exceptions that occur during an API request.