Interface RevSchemaServer<SF>

Interface representing a schema server.

See

Schema Server Interface 🗎

interface RevSchemaServer<SF extends RevSchemaField> {
    getFields(): readonly SF[];
    subscribeSchemaNotifications(
        client: RevSchemaServer.NotificationsClient<SF>,
    ): void;
    unsubscribeSchemaNotifications(
        client: RevSchemaServer.NotificationsClient<SF>,
    ): void;
}

Type Parameters

SF extends RevSchemaField
The type of schema field used to specify the field columns.

Client grid uses this interface to retrieve the schema fields which are the field columns in the grid. It also uses it to get notified about changes to the schema.

Implemented by

Index

Methods

getFields subscribeSchemaNotifications unsubscribeSchemaNotifications?

Methods

getFields

getFields(): readonly SF[]
Get list of fields.

The order of these fields defines the orders of field columns in Columns Manager.

Returns readonly SF[]

subscribeSchemaNotifications

subscribeSchemaNotifications(
client: RevSchemaServer.NotificationsClient<SF>,
): void
Parameters
- client: RevSchemaServer.NotificationsClient<SF>
Returns void

`Optional`unsubscribeSchemaNotifications

unsubscribeSchemaNotifications(
client: RevSchemaServer.NotificationsClient<SF>,
): void
Parameters
- client: RevSchemaServer.NotificationsClient<SF>
Returns void