device library

Device service from Ant Investor Profile package.

Classes

AddKeyRequest
AddKeyRequest adds a key or token to a device. Keys are used for secure communications (Matrix E2EE, push notifications, FCM tokens, etc.).
AddKeyResponse
AddKeyResponse returns the created key.
CreateRequest
CreateRequest registers a new device in the system.
CreateResponse
CreateResponse returns the newly created device.
DeRegisterKeyRequest
DeRegisterKeyRequest removes device registration from third-party services. This cleans up the connection with external services like FCM.
DeRegisterKeyResponse
DeRegisterKeyResponse confirms service deregistration.
DeviceLog
DeviceLog represents an activity log entry for a device. Logs track device sessions, locations, and activity for security auditing.
DeviceObject
DeviceObject represents a registered device in the system. Devices must be registered and linked to a profile before use.
DeviceService
DeviceService provides core device management and key/token management. All RPCs require authentication via Bearer token unless otherwise specified.
DeviceServiceApi
GetByIdRequest
GetByIdRequest retrieves one or more devices by their unique identifiers.
GetByIdResponse
GetByIdResponse returns the requested devices.
GetBySessionIdRequest
GetBySessionIdRequest retrieves a device by its active session identifier.
GetBySessionIdResponse
GetBySessionIdResponse returns the device associated with the session.
GetTurnCredentialsRequest
GetTurnCredentialsResponse
KeyObject
KeyObject represents a key or token associated with a device. Keys are used for secure communications, authentication, and push notifications.
KeyType
KeyType defines the types of keys that can be stored for a device. Different key types serve different purposes in the security infrastructure. buf:lint:ignore ENUM_VALUE_PREFIX
LinkRequest
LinkRequest links a device to a user profile. Devices must be linked before they can be used for authenticated operations.
LinkResponse
LinkResponse returns the linked device.
ListLogsRequest
ListLogsRequest retrieves activity logs for a device. Useful for security auditing and tracking device usage patterns.
ListLogsResponse
ListLogsResponse returns device activity logs.
Locale
Locale represents the localization settings for a device. Used to provide localized content and format data appropriately for the user.
LogRequest
LogRequest creates a new activity log entry for a device. Used for tracking device sessions and security auditing.
LogResponse
LogResponse returns the created log entry.
NotifyMessage
NotifyPayload represents the content and metadata of a single notification.
NotifyRequest
NotifyRequest sends one or more notifications to a device using its registered keys. The service will select an appropriate key based on key_type (e.g., FCM_TOKEN for push notifications).
NotifyResponse
NotifyResponse confirms the notifications were sent.
NotifyResult
NotifyResult details the outcome of sending an individual notification payload.
PresenceObject
PresenceObject represents the presence/availability status of a device. Tracks online/offline status and last activity for real-time communication features.
PresenceStatus
PresenceStatus defines the online/offline status of a device. buf:lint:ignore ENUM_VALUE_PREFIX
RegisterKeyRequest
RegisterKeyRequest registers a device with third-party services. Used when the key/token is generated by the third-party service (e.g., FCM token generated on device by FCM SDK). This links the device to the external service. For storing key material, use AddKeyRequest instead.
RegisterKeyResponse
RegisterKeyResponse returns confirmation of registration. The actual key/token data is managed by the third-party service.
RemoveKeyRequest
RemoveKeyRequest removes one or more keys or tokens from a device. Used when rotating keys, removing tokens, or removing a device.
RemoveKeyResponse
RemoveKeyResponse returns the IDs of removed keys.
RemoveRequest
RemoveRequest removes a device from the system. This is typically used when a user logs out or removes a device from their account.
RemoveResponse
RemoveResponse returns the removed device.
SearchKeyRequest
SearchKeyRequest searches for keys or tokens associated with a device.
SearchKeyResponse
SearchKeyResponse returns matching keys or tokens.
SearchRequest
SearchRequest searches for devices matching specified criteria.
SearchResponse
SearchResponse returns devices matching the search criteria.
TurnServer
UpdatePresenceRequest
UpdatePresenceRequest updates the presence status of a device.
UpdatePresenceResponse
UpdatePresenceResponse returns the updated presence.
UpdateRequest
UpdateRequest updates an existing device's information.
UpdateResponse
UpdateResponse returns the updated device.

Extension Types

DeviceServiceClient
DeviceService provides core device management and key/token management. All RPCs require authentication via Bearer token unless otherwise specified.

Constants

AddKeyRequest$json → const Map<String, Object>
AddKeyResponse$json → const Map<String, Object>
CreateRequest$json → const Map<String, Object>
CreateResponse$json → const Map<String, Object>
DeRegisterKeyRequest$json → const Map<String, Object>
DeRegisterKeyResponse$json → const Map<String, Object>
DeviceLog$json → const Map<String, Object>
DeviceObject$json → const Map<String, Object>
DeviceServiceBase$json → const Map<String, dynamic>
DeviceServiceBase$messageJson → const Map<String, Map<String, dynamic>>
GetByIdRequest$json → const Map<String, Object>
GetByIdResponse$json → const Map<String, Object>
GetBySessionIdRequest$json → const Map<String, Object>
GetBySessionIdResponse$json → const Map<String, Object>
GetTurnCredentialsRequest$json → const Map<String, Object>
GetTurnCredentialsResponse$json → const Map<String, Object>
KeyObject$json → const Map<String, Object>
KeyType$json → const Map<String, Object>
LinkRequest$json → const Map<String, Object>
LinkResponse$json → const Map<String, Object>
ListLogsRequest$json → const Map<String, Object>
ListLogsResponse$json → const Map<String, Object>
Locale$json → const Map<String, Object>
LogRequest$json → const Map<String, Object>
LogResponse$json → const Map<String, Object>
NotifyMessage$json → const Map<String, Object>
NotifyRequest$json → const Map<String, Object>
NotifyResponse$json → const Map<String, Object>
NotifyResult$json → const Map<String, Object>
PresenceObject$json → const Map<String, Object>
PresenceStatus$json → const Map<String, Object>
RegisterKeyRequest$json → const Map<String, Object>
RegisterKeyResponse$json → const Map<String, Object>
RemoveKeyRequest$json → const Map<String, Object>
RemoveKeyResponse$json → const Map<String, Object>
RemoveRequest$json → const Map<String, Object>
RemoveResponse$json → const Map<String, Object>
SearchKeyRequest$json → const Map<String, Object>
SearchKeyResponse$json → const Map<String, Object>
SearchRequest$json → const Map<String, Object>
SearchResponse$json → const Map<String, Object>
TurnServer$json → const Map<String, Object>
UpdatePresenceRequest$json → const Map<String, Object>
UpdatePresenceResponse$json → const Map<String, Object>
UpdateRequest$json → const Map<String, Object>
UpdateResponse$json → const Map<String, Object>

Properties

addKeyRequestDescriptor → Uint8List
Descriptor for AddKeyRequest. Decode as a google.protobuf.DescriptorProto.
final
addKeyResponseDescriptor → Uint8List
Descriptor for AddKeyResponse. Decode as a google.protobuf.DescriptorProto.
final
createRequestDescriptor → Uint8List
Descriptor for CreateRequest. Decode as a google.protobuf.DescriptorProto.
final
createResponseDescriptor → Uint8List
Descriptor for CreateResponse. Decode as a google.protobuf.DescriptorProto.
final
deRegisterKeyRequestDescriptor → Uint8List
Descriptor for DeRegisterKeyRequest. Decode as a google.protobuf.DescriptorProto.
final
deRegisterKeyResponseDescriptor → Uint8List
Descriptor for DeRegisterKeyResponse. Decode as a google.protobuf.DescriptorProto.
final
deviceLogDescriptor → Uint8List
Descriptor for DeviceLog. Decode as a google.protobuf.DescriptorProto.
final
deviceObjectDescriptor → Uint8List
Descriptor for DeviceObject. Decode as a google.protobuf.DescriptorProto.
final
deviceServiceDescriptor → Uint8List
Descriptor for DeviceService. Decode as a google.protobuf.ServiceDescriptorProto.
final
getByIdRequestDescriptor → Uint8List
Descriptor for GetByIdRequest. Decode as a google.protobuf.DescriptorProto.
final
getByIdResponseDescriptor → Uint8List
Descriptor for GetByIdResponse. Decode as a google.protobuf.DescriptorProto.
final
getBySessionIdRequestDescriptor → Uint8List
Descriptor for GetBySessionIdRequest. Decode as a google.protobuf.DescriptorProto.
final
getBySessionIdResponseDescriptor → Uint8List
Descriptor for GetBySessionIdResponse. Decode as a google.protobuf.DescriptorProto.
final
getTurnCredentialsRequestDescriptor → Uint8List
Descriptor for GetTurnCredentialsRequest. Decode as a google.protobuf.DescriptorProto.
final
getTurnCredentialsResponseDescriptor → Uint8List
Descriptor for GetTurnCredentialsResponse. Decode as a google.protobuf.DescriptorProto.
final
keyObjectDescriptor → Uint8List
Descriptor for KeyObject. Decode as a google.protobuf.DescriptorProto.
final
keyTypeDescriptor → Uint8List
Descriptor for KeyType. Decode as a google.protobuf.EnumDescriptorProto.
final
linkRequestDescriptor → Uint8List
Descriptor for LinkRequest. Decode as a google.protobuf.DescriptorProto.
final
linkResponseDescriptor → Uint8List
Descriptor for LinkResponse. Decode as a google.protobuf.DescriptorProto.
final
listLogsRequestDescriptor → Uint8List
Descriptor for ListLogsRequest. Decode as a google.protobuf.DescriptorProto.
final
listLogsResponseDescriptor → Uint8List
Descriptor for ListLogsResponse. Decode as a google.protobuf.DescriptorProto.
final
localeDescriptor → Uint8List
Descriptor for Locale. Decode as a google.protobuf.DescriptorProto.
final
logRequestDescriptor → Uint8List
Descriptor for LogRequest. Decode as a google.protobuf.DescriptorProto.
final
logResponseDescriptor → Uint8List
Descriptor for LogResponse. Decode as a google.protobuf.DescriptorProto.
final
notifyMessageDescriptor → Uint8List
Descriptor for NotifyMessage. Decode as a google.protobuf.DescriptorProto.
final
notifyRequestDescriptor → Uint8List
Descriptor for NotifyRequest. Decode as a google.protobuf.DescriptorProto.
final
notifyResponseDescriptor → Uint8List
Descriptor for NotifyResponse. Decode as a google.protobuf.DescriptorProto.
final
notifyResultDescriptor → Uint8List
Descriptor for NotifyResult. Decode as a google.protobuf.DescriptorProto.
final
presenceObjectDescriptor → Uint8List
Descriptor for PresenceObject. Decode as a google.protobuf.DescriptorProto.
final
presenceStatusDescriptor → Uint8List
Descriptor for PresenceStatus. Decode as a google.protobuf.EnumDescriptorProto.
final
registerKeyRequestDescriptor → Uint8List
Descriptor for RegisterKeyRequest. Decode as a google.protobuf.DescriptorProto.
final
registerKeyResponseDescriptor → Uint8List
Descriptor for RegisterKeyResponse. Decode as a google.protobuf.DescriptorProto.
final
removeKeyRequestDescriptor → Uint8List
Descriptor for RemoveKeyRequest. Decode as a google.protobuf.DescriptorProto.
final
removeKeyResponseDescriptor → Uint8List
Descriptor for RemoveKeyResponse. Decode as a google.protobuf.DescriptorProto.
final
removeRequestDescriptor → Uint8List
Descriptor for RemoveRequest. Decode as a google.protobuf.DescriptorProto.
final
removeResponseDescriptor → Uint8List
Descriptor for RemoveResponse. Decode as a google.protobuf.DescriptorProto.
final
searchKeyRequestDescriptor → Uint8List
Descriptor for SearchKeyRequest. Decode as a google.protobuf.DescriptorProto.
final
searchKeyResponseDescriptor → Uint8List
Descriptor for SearchKeyResponse. Decode as a google.protobuf.DescriptorProto.
final
searchRequestDescriptor → Uint8List
Descriptor for SearchRequest. Decode as a google.protobuf.DescriptorProto.
final
searchResponseDescriptor → Uint8List
Descriptor for SearchResponse. Decode as a google.protobuf.DescriptorProto.
final
turnServerDescriptor → Uint8List
Descriptor for TurnServer. Decode as a google.protobuf.DescriptorProto.
final
updatePresenceRequestDescriptor → Uint8List
Descriptor for UpdatePresenceRequest. Decode as a google.protobuf.DescriptorProto.
final
updatePresenceResponseDescriptor → Uint8List
Descriptor for UpdatePresenceResponse. Decode as a google.protobuf.DescriptorProto.
final
updateRequestDescriptor → Uint8List
Descriptor for UpdateRequest. Decode as a google.protobuf.DescriptorProto.
final
updateResponseDescriptor → Uint8List
Descriptor for UpdateResponse. Decode as a google.protobuf.DescriptorProto.
final