package nearby.sharing.service.proto

Get desktop application:
View/edit binary Protocol Buffers messages

NEXT_ID=8

Used in: IntroductionFrame

• optional string app_name = 1

  The app name. This will be sent in introduction.

• optional int64 size = 2

  The size of the all split of apks.

• repeated int64 payload_id = 3

  The File payload id that will be sent as a follow up containing the apk paths.

• optional int64 id = 4

  A uuid for the attachment. Should be unique across all attachments.

• repeated string file_name = 5

  The name of apk file. This will be sent in introduction.

• repeated int64 file_size = 6

  The size of apk file. This will be sent in introduction.

• optional string package_name = 7

  The package name. This will be sent in introduction.

Attachment details that sent in ConnectionResponseFrame. NEXT_ID=3

Used in: ConnectionResponseFrame

• optional AttachmentDetails.Type type = 1

  The attachment family type.

• optional FileAttachmentDetails file_attachment_details = 2

  This field is only for FILE type.

LINT.IfChange

Used in: AttachmentDetails

• UNKNOWN = 0

• FILE = 1

  Represents FileAttachment.

• TEXT = 2

  Represents TextAttachment.

• WIFI_CREDENTIALS = 3

  Represents WifiCredentialsAttachment.

• APP = 4

  Represents AppAttachment.

• STREAM = 5

  Represents StreamAttachment.

Messages used to create pair bindings between devices. An initiator device requests a new bindingId from the BE using the InitiateBinding rpc. This new bindingId is passed to the peer device using a BindingRequest frame. The peer device will use this bindingId to call JoinBinding rpc. If successful, the peer device is response with a BindingResponse frame with status of SUCCESS.

Used in: V1Frame

• oneof content

  • BindingRequest binding_request = 1

  • BindingResponse binding_response = 2

Used in: BindingFrame

• optional string binding_id = 1

• optional BindingRequest.Type type = 2

Used in: BindingRequest

• UNKNOWN = 0

• FILESYNC = 1

Used in: BindingFrame

• optional BindingResponse.Status status = 1

Used in: BindingResponse

• UNKNOWN = 0

• SUCCESS = 1

• FAILURE = 2

  TODO: b/485307320 - Add more specific error codes.

A package containing certificate info to be shared to remote device offline. NEXT_ID=2

Used in: V1Frame

• repeated PublicCertificate public_certificate = 1

  The public certificates to be shared with remote devices.

A response packet sent by the receiving side. Accepts or rejects the list of files. NEXT_ID=4

Used in: V1Frame

• optional ConnectionResponseFrame.Status status = 1

  The receiving side's response.

• map<int64, AttachmentDetails> attachment_details = 2

  Key is attachment hash, value is the details of attachment.

• repeated StreamMetadata stream_metadata = 3

  In the case of a stream attachments, the other side of the pipe. Both sender and receiver should validate matching counts.

Used in: ConnectionResponseFrame

• UNKNOWN = 0

• ACCEPT = 1

• REJECT = 2

• NOT_ENOUGH_SPACE = 3

• UNSUPPORTED_ATTACHMENT_TYPE = 4

• TIMED_OUT = 5

File attachment details included in ConnectionResponseFrame. NEXT_ID=3

Used in: AttachmentDetails

• optional int64 receiver_existing_file_size = 1

  Existing local file size on receiver side.

• map<int64, PayloadsDetails> attachment_hash_payloads = 2

  The key is attachment hash, a stable identifier for the attachment. Value is list of payload details transferred for the attachment.

File metadata. Does not include the actual bytes of the file. NEXT_ID=10

Used in: IntroductionFrame

• optional string name = 1

  The human readable name of this file (eg. 'Cookbook.pdf').

• optional FileMetadata.Type type = 2

  The type of file (eg. 'IMAGE' from 'dog.jpg'). Specifying a type helps provide a richer experience on the receiving side.

• optional int64 payload_id = 3

  The FILE payload id that will be sent as a follow up containing the actual bytes of the file.

• optional int64 size = 4

  The total size of the file.

• optional string mime_type = 5

  The mimeType of file (eg. 'image/jpeg' from 'dog.jpg'). Specifying a mimeType helps provide a richer experience on receiving side.

• optional int64 id = 6

  A uuid for the attachment. Should be unique across all attachments.

• optional string parent_folder = 7

  The parent folder.

• optional int64 attachment_hash = 8

  A stable identifier for the attachment. Used for receiver to identify same attachment from different transfers.

• optional bool is_sensitive_content = 9

  True, if image in file attachment is sensitive

Used in: FileMetadata

• UNKNOWN = 0

• IMAGE = 1

• VIDEO = 2

• ANDROID_APP = 3

• AUDIO = 4

• DOCUMENT = 5

• CONTACT_CARD = 6

A frame used when sending messages over the wire. NEXT_ID=3

• optional Frame.Version version = 1

• optional V1Frame v1 = 2

  Right now there's only 1 version, but if there are more, exactly one of the following fields will be set.

Used in: Frame

• UNKNOWN_VERSION = 0

• V1 = 1

An introduction packet sent by the sending side. Contains a list of files they'd like to share. NEXT_ID=10

Used in: V1Frame

• repeated FileMetadata file_metadata = 1

• repeated TextMetadata text_metadata = 2

• optional string required_package = 3

  The required app package to open the content. May be null.

• repeated WifiCredentialsMetadata wifi_credentials_metadata = 4

• repeated AppMetadata app_metadata = 5

• optional bool start_transfer = 6

• repeated StreamMetadata stream_metadata = 7

• optional IntroductionFrame.SharingUseCase use_case = 8

• repeated int64 preview_payload_ids = 9

Used in: IntroductionFrame

• UNKNOWN = 0

• NEARBY_SHARE = 1

• REMOTE_COPY = 2

• TAP_TO_SHARE = 9

A paired key encryption packet sent between devices, contains signed data. NEXT_ID=5

Used in: V1Frame

• optional bytes signed_data = 1

  The encrypted data in byte array format.

• optional bytes secret_id_hash = 2

  The hash of a certificate id.

• optional bytes optional_signed_data = 3

  An optional encrypted data in byte array format.

• optional bytes qr_code_handshake_data = 4

  An optional QR code handshake data in a byte array format. For incoming connection contains a signature of the UKEY2 token, created with the sender's private key. For outgoing connection contains an HKDF of the connection token and of the UKEY2 token

A paired key verification result packet sent between devices. NEXT_ID=3

Used in: V1Frame

• optional PairedKeyResultFrame.Status status = 1

  The verification result.

• optional location.nearby.proto.sharing.OSType os_type = 2

  OS type.

Used in: PairedKeyResultFrame

• UNKNOWN = 0

• SUCCESS = 1

• FAIL = 2

• UNABLE = 3

Metadata of a payload file created by Nearby Connections. NEXT_ID=4

Used in: PayloadsDetails

• optional int64 id = 1

• optional int64 creation_timestamp_millis = 2

• optional int64 size = 3

NEXT_ID=2

Used in: FileAttachmentDetails

• repeated PayloadDetails payload_details = 1

  The list should be sorted by creation timestamp.

A progress update packet sent by the sending side. Contains transfer progress value. NEXT_ID=3

Used in: V1Frame

• optional float progress = 1

• optional bool start_transfer = 2

  True, if the receiver should start bandwidth upgrade and receiving the payloads.

A public certificate from the local device. NEXT_ID=8

Used in: CertificateInfoFrame

• optional bytes secret_id = 1

  The unique id of the public certificate.

• optional bytes authenticity_key = 2

  A bytes representation of a Secret Key owned by contact, to decrypt the metadata_key stored within the advertisement.

• optional bytes public_key = 3

  A bytes representation a public key of X509Certificate, owned by contact, to decrypt encrypted UKEY2 (from Nearby Connections API) as a hand shake in contact verification phase.

• optional int64 start_time = 4

  The time in millis from epoch when this certificate becomes effective.

• optional int64 end_time = 5

  The time in millis from epoch when this certificate expires.

• optional bytes encrypted_metadata_bytes = 6

  The encrypted metadata in bytes, contains personal information of the device/user who created this certificate. Needs to be decrypted into bytes, and converted back to EncryptedMetadata object to access fields.

• optional bytes metadata_encryption_key_tag = 7

  The tag for verifying metadata_encryption_key.

NEXT_ID=2

• optional bytes input_stream_parcel_file_descriptor_bytes = 1

  Serialized ParcelFileDescriptor for input stream (for the receiver).

NEXT_ID=5

Used in: ConnectionResponseFrame, IntroductionFrame

• optional string description = 1

  A human readable description for the stream.

• optional string package_name = 2

  The package name of the sending application.

• optional int64 payload_id = 3

  The payload type id that will be sent as a followup containing the ParcelFileDescriptor.

• optional string attributed_app_name = 4

  The human-readable name of the package that should be displayed as attribution if no other information is available (i.e. the package is not installed locally yet).

NEXT_ID=8

Used in: IntroductionFrame

• optional string text_title = 2

  The title of the text content.

• optional TextMetadata.Type type = 3

  The type of text (phone number, url, address, or plain text).

• optional int64 payload_id = 4

  The BYTE payload id that will be sent as a follow up containing the actual bytes of the text.

• optional int64 size = 5

  The size of the text content.

• optional int64 id = 6

  A uuid for the attachment. Should be unique across all attachments.

• optional bool is_sensitive_text = 7

  True if text is sensitive, e.g. password

Used in: TextMetadata

• UNKNOWN = 0

• TEXT = 1

• URL = 2

  Open with browsers.

• ADDRESS = 3

  Open with map apps.

• PHONE_NUMBER = 4

  Dial.

NEXT_ID=9

Used in: Frame

• optional V1Frame.FrameType type = 1

• optional IntroductionFrame introduction = 2

  At most one of the following fields will be set.

• optional ConnectionResponseFrame connection_response = 3

• optional PairedKeyEncryptionFrame paired_key_encryption = 4

• optional PairedKeyResultFrame paired_key_result = 5

• optional CertificateInfoFrame certificate_info = 6

• optional ProgressUpdateFrame progress_update = 7

• optional BindingFrame bindings = 8

Used in: V1Frame

• UNKNOWN_FRAME_TYPE = 0

• INTRODUCTION = 1

• RESPONSE = 2

• PAIRED_KEY_ENCRYPTION = 3

• PAIRED_KEY_RESULT = 4

• CERTIFICATE_INFO = 5

  No longer used.

• CANCEL = 6

• PROGRESS_UPDATE = 7

  No longer used.

• BINDINGS = 8

NEXT_ID=3

• optional string password = 1

  Wi-Fi password.

• optional bool hidden_ssid = 2

  True if the network is a hidden network that is not broadcasting its SSID. Default is false.

NEXT_ID=6

Used in: IntroductionFrame

• optional string ssid = 2

  The Wifi network name. This will be sent in introduction.

• optional WifiCredentialsMetadata.SecurityType security_type = 3

  The security type of network (OPEN, WPA_PSK, WEP).

• optional int64 payload_id = 4

  The BYTE payload id that will be sent as a follow up containing the password.

• optional int64 id = 5

  A uuid for the attachment. Should be unique across all attachments.

Used in: WifiCredentialsMetadata

• UNKNOWN_SECURITY_TYPE = 0

• OPEN = 1

• WPA_PSK = 2

• WEP = 3

• SAE = 4