package cs3.preferences.v1beta1

Get desktop application:
View/edit binary Protocol Buffers messages

Preferences API. The Preferences API is responsible for creating a key-value map according to user preferences. The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119. The following are global requirements that apply to all methods: Any method MUST return CODE_OK on a succesful operation. Any method MAY return NOT_IMPLEMENTED. Any method MAY return INTERNAL. Any method MAY return UNKNOWN. Any method MAY return UNAUTHENTICATED.

• rpc GetKey (GetKeyRequest, GetKeyResponse)

  preferences_api.proto:55

  Returns the value associated with the requested key.

• rpc SetKey (SetKeyRequest, SetKeyResponse)

  preferences_api.proto:52

  Maps the key-value pair.

Used as request type in: gateway.v1beta1.GatewayAPI.GetKey, PreferencesAPI.GetKey

• optional PreferenceKey key = 1

  REQUIRED.

Used as response type in: gateway.v1beta1.GatewayAPI.GetKey, PreferencesAPI.GetKey

• optional rpc.v1beta1.Status status = 1

  REQUIRED. The response status.

• string val = 2

  REQUIRED. The value associated with the key.

Represents a key object consisting of a namespace and a string key.

Used in: GetKeyRequest, SetKeyRequest

• string namespace = 1

  REQUIRED. The namespace to which the key belongs.

• string key = 2

  REQUIRED.

Used as request type in: gateway.v1beta1.GatewayAPI.SetKey, PreferencesAPI.SetKey

• optional PreferenceKey key = 1

  REQUIRED.

• string val = 2

  REQUIRED. The value associated with the key.

Used as response type in: gateway.v1beta1.GatewayAPI.SetKey, PreferencesAPI.SetKey

• optional rpc.v1beta1.Status status = 1

  REQUIRED. The response status.