Service: Push

This API is officially released and maintained.

An gRPC service to configure multiple push settings

Table 1. Available methods
Method Request Response

Store

PushStoreRequest

google.protobuf.Empty

Delete

PushDeleteRequest

google.protobuf.Empty

List

google.protobuf.Empty

PushListResponse

Watch

google.protobuf.Empty

PushWatchResponseStream

Enable

PushEnableRequest

google.protobuf.Empty

Disable

PushDisableRequest

google.protobuf.Empty

Store

Store (Add or Update a push configuration)

Request

request to add a push configuration

Table 2. Available fields in blickfeld.push.services.PushStoreRequest
Field Type Default Unit

uuid

string

-

-

the uuid of the configuration (has to be generated on client side!)

push_config

config.Push

-

-

push configuration to add

Delete

Delete an existing push configuration

Request

request to delete a push configuration

Table 3. Available fields in blickfeld.push.services.PushDeleteRequest
Field Type Default Unit

uuid

string

-

-

configuration uuid to delete

List

List configured push configuration

Response

request to list all configured push configurations

Table 4. Available fields in blickfeld.push.services.PushListResponse
Field Type Default Unit

push_configs

repeated PushConfigsEntry

-

-

current snapshot of configured push configurations

Push Configs Entry

Table 5. Available fields in blickfeld.push.services.PushListResponse.PushConfigsEntry
Field Type Default Unit

key

string

-

-

value

config.Push

-

-

Watch

Watch list of configured push configuration

Response Stream

request to watch all configured push configurations

Table 6. Available fields in blickfeld.push.services.PushWatchResponse
Field Type Default Unit

push_configs

repeated PushConfigsEntry

-

-

current snapshot of configured push configurations

Push Configs Entry

Table 7. Available fields in blickfeld.push.services.PushWatchResponse.PushConfigsEntry
Field Type Default Unit

key

string

-

-

value

config.Push

-

-

Enable

Enable a configured Push

Request

request to enable the push configuration with the given uuid

Table 8. Available fields in blickfeld.push.services.PushEnableRequest
Field Type Default Unit

uuid

string

-

-

configuration uuid to enable

Disable

Disable a configured Push

Request

request to disable the push configuration with the given uuid

Table 9. Available fields in blickfeld.push.services.PushDisableRequest
Field Type Default Unit

uuid

string

-

-

configuration uuid to disable