एक्सचेंज का डेटा

डिवाइसों के बीच कनेक्शन बन जाने के बाद, इनके ज़रिए डेटा शेयर किया जा सकता है: Payload ऑब्जेक्ट भेजना और पाना. ऐप्लिकेशन Payload, किसी सामान्य बाइट अरे को दिखा सकता है, जैसे कि छोटा टेक्स्ट मैसेज; फ़ाइल, जैसे कि कोई फ़ोटो या वीडियो; या कोई स्ट्रीम, जैसे कि डिवाइस के माइक्रोफ़ोन.

पेलोड, sendPayload() तरीके का इस्तेमाल करके भेजे जाते हैं. साथ ही, इन्हें PayloadCallback को लागू करके, acceptConnection() को भेजा जाता है. इसकी जानकारी कनेक्शन मैनेज करें में दी गई है.

ध्यान दें: PayloadCallback.onPayloadReceived() तब कॉल किया जाता है, जब पेलोड का पहला बाइट होता है मिल गए हैं; इसमें यह जानकारी नहीं दी गई है कि पूरा पेलोड मिल गया है. कॉन्टेंट बनाने ट्रांसफ़र पूरा होने का संकेत तब मिलता है, जब PayloadCallback.onPayloadTransferUpdate() कॉल की स्थिति PayloadTransferUpdate.Status.SUCCESS है (या PayloadTransferUpdate.Status.ERROR). इसका एक अपवाद है BYTES टाइप के पेलोड के लिए; ज़्यादा जानकारी के लिए, बाइट सेक्शन में जाएं.

पेलोड के टाइप

बाइट

बाइट पेलोड, सबसे आसान तरह के पेलोड होते हैं. ये ईमेल भेजने के लिए सही हैं मैसेज या मेटाडेटा जैसे सामान्य डेटा का साइज़ Connections.MAX_BYTES_DATA_SIZE से ज़्यादा नहीं होना चाहिए. यहां BYTES पेलोड भेजने का उदाहरण दिया गया है:

Payload bytesPayload = Payload.fromBytes(new byte[] {0xa, 0xb, 0xc, 0xd});
Nearby.getConnectionsClient(context).sendPayload(toEndpointId, bytesPayload);

आपने acceptConnection() को जो PayloadCallback पास किया है उसकी onPayloadReceived() विधि लागू करके BYTES पेलोड पाएं.

static class ReceiveBytesPayloadListener extends PayloadCallback {

  @Override
  public void onPayloadReceived(String endpointId, Payload payload) {
    // This always gets the full data of the payload. Is null if it's not a BYTES payload.
    if (payload.getType() == Payload.Type.BYTES) {
      byte[] receivedBytes = payload.asBytes();
    }
  }

  @Override
  public void onPayloadTransferUpdate(String endpointId, PayloadTransferUpdate update) {
    // Bytes payloads are sent as a single chunk, so you'll receive a SUCCESS update immediately
    // after the call to onPayloadReceived().
  }
}

FILE और STREAM पेलोड के उलट, BYTES पेलोड सिंगल के तौर पर भेजे जाते हैं डेटा का इस्तेमाल करें, इसलिए SUCCESS के अपडेट के लिए इंतज़ार करने की ज़रूरत नहीं है (हालांकि, ऐसा होगा हालांकि, onPayloadReceived() पर कॉल करने के तुरंत बाद डिलीवर नहीं किया जाएगा). इसके बजाय, आप इसका पूरा डेटा पाने के लिए payload.asBytes() को सुरक्षित रूप से कॉल कर सकते हैं onPayloadReceived() को कॉल करते ही पेलोड डालें.

फ़ाइल

फ़ाइल पेलोड लोकल डिवाइस पर सेव की गई किसी फ़ाइल से बनाए जाते हैं, जैसे कि फ़ोटो या वीडियो फ़ाइल में सेव किया जाएगा. FILE पेलोड भेजने का एक आसान उदाहरण यहां दिया गया है:

File fileToSend = new File(context.getFilesDir(), "hello.txt");
try {
  Payload filePayload = Payload.fromFile(fileToSend);
  Nearby.getConnectionsClient(context).sendPayload(toEndpointId, filePayload);
} catch (FileNotFoundException e) {
  Log.e("MyApp", "File not found", e);
}

अगर FILES पेलोड उपलब्ध हो, तो उसे बनाने के लिए ParcelFileDescriptor का इस्तेमाल करना ज़्यादा बेहतर हो सकता है. उदाहरण के लिए, ContentResolver से. इससे फ़ाइल के बाइट कॉपी करना कम हो जाता है:

ParcelFileDescriptor pfd = getContentResolver().openFileDescriptor(uri, "r");
filePayload = Payload.fromFile(pfd);

जब कोई फ़ाइल मिलती है, तो वह फ़ाइल पाने वाले व्यक्ति के डिवाइस की फ़ोल्डर में डाउनलोड फ़ोल्डर (DIRECTORY_DOWNLOADS) में सेव हो जाती है इस डिवाइस का इस्तेमाल किया जा सकता है. ट्रांसफ़र पूरा होने पर, onPayloadTransferUpdate() को किए गए कॉल द्वारा संकेत किया गया PayloadTransferUpdate.Status.SUCCESS, आप इस तरह File ऑब्जेक्ट को फिर से पा सकते हैं, अगर आपका ऐप्लिकेशन < Q डिवाइस:

File payloadFile = filePayload.asFile().asJavaFile();

// Rename the file.
payloadFile.renameTo(new File(payloadFile.getParentFile(), filename));

अगर आपका ऐप्लिकेशन Q डिवाइसों को टारगेट कर रहा है, तो आपके पास android:requestLegacyExternalStorage="true" जोड़ने का विकल्प है पिछले कोड का इस्तेमाल जारी रखने के लिए, अपने मेनिफ़ेस्ट के ऐप्लिकेशन एलिमेंट में जाएं. अगर ऐसा नहीं है, तो Q+ के लिए आपको Scoped Storage के नियमों का पालन करना होगा. साथ ही, सेवा से पास किए गए यूआरआई का इस्तेमाल करके मिली फ़ाइल को ऐक्सेस करना होगा.

// Because of https://developer.android.com/preview/privacy/scoped-storage, we are not
// allowed to access filepaths from another process directly. Instead, we must open the
// uri using our ContentResolver.
Uri uri = filePayload.asFile().asUri();
try {
  // Copy the file to a new location.
  InputStream in = context.getContentResolver().openInputStream(uri);
  copyStream(in, new FileOutputStream(new File(context.getCacheDir(), filename)));
} catch (IOException e) {
  // Log the error.
} finally {
  // Delete the original file.
  context.getContentResolver().delete(uri, null, null);
}

नीचे दिए गए ज़्यादा जटिल उदाहरण में, ACTION_OPEN_DOCUMENT इंटेंट उपयोगकर्ता को एक फ़ाइल चुनने का अनुरोध करता है और ParcelFileDescriptor का इस्तेमाल करके फ़ाइल को पेलोड के तौर पर असरदार तरीके से भेजा जाता है. फ़ाइल के नाम को BYTES पेलोड के तौर पर भी भेजा गया है.

private static final int READ_REQUEST_CODE = 42;
private static final String ENDPOINT_ID_EXTRA = "com.foo.myapp.EndpointId";

/**
 * Fires an intent to spin up the file chooser UI and select an image for sending to endpointId.
 */
private void showImageChooser(String endpointId) {
  Intent intent = new Intent(Intent.ACTION_OPEN_DOCUMENT);
  intent.addCategory(Intent.CATEGORY_OPENABLE);
  intent.setType("image/*");
  intent.putExtra(ENDPOINT_ID_EXTRA, endpointId);
  startActivityForResult(intent, READ_REQUEST_CODE);
}

@Override
public void onActivityResult(int requestCode, int resultCode, Intent resultData) {
  super.onActivityResult(requestCode, resultCode, resultData);
  if (requestCode == READ_REQUEST_CODE
      && resultCode == Activity.RESULT_OK
      && resultData != null) {
    String endpointId = resultData.getStringExtra(ENDPOINT_ID_EXTRA);

    // The URI of the file selected by the user.
    Uri uri = resultData.getData();

    Payload filePayload;
    try {
      // Open the ParcelFileDescriptor for this URI with read access.
      ParcelFileDescriptor pfd = getContentResolver().openFileDescriptor(uri, "r");
      filePayload = Payload.fromFile(pfd);
    } catch (FileNotFoundException e) {
      Log.e("MyApp", "File not found", e);
      return;
    }

    // Construct a simple message mapping the ID of the file payload to the desired filename.
    String filenameMessage = filePayload.getId() + ":" + uri.getLastPathSegment();

    // Send the filename message as a bytes payload.
    Payload filenameBytesPayload =
        Payload.fromBytes(filenameMessage.getBytes(StandardCharsets.UTF_8));
    Nearby.getConnectionsClient(context).sendPayload(endpointId, filenameBytesPayload);

    // Finally, send the file payload.
    Nearby.getConnectionsClient(context).sendPayload(endpointId, filePayload);
  }
}

चूंकि फ़ाइल नाम को पेलोड के रूप में भेजा गया था, इसलिए हमारा प्राप्तकर्ता फ़ाइल को स्थानांतरित कर सकता है या उसका नाम बदल सकता है, ताकि उसका एक उपयुक्त एक्सटेंशन हो:

static class ReceiveFilePayloadCallback extends PayloadCallback {
  private final Context context;
  private final SimpleArrayMap<Long, Payload> incomingFilePayloads = new SimpleArrayMap<>();
  private final SimpleArrayMap<Long, Payload> completedFilePayloads = new SimpleArrayMap<>();
  private final SimpleArrayMap<Long, String> filePayloadFilenames = new SimpleArrayMap<>();

  public ReceiveFilePayloadCallback(Context context) {
    this.context = context;
  }

  @Override
  public void onPayloadReceived(String endpointId, Payload payload) {
    if (payload.getType() == Payload.Type.BYTES) {
      String payloadFilenameMessage = new String(payload.asBytes(), StandardCharsets.UTF_8);
      long payloadId = addPayloadFilename(payloadFilenameMessage);
      processFilePayload(payloadId);
    } else if (payload.getType() == Payload.Type.FILE) {
      // Add this to our tracking map, so that we can retrieve the payload later.
      incomingFilePayloads.put(payload.getId(), payload);
    }
  }

  /**
   * Extracts the payloadId and filename from the message and stores it in the
   * filePayloadFilenames map. The format is payloadId:filename.
   */
  private long addPayloadFilename(String payloadFilenameMessage) {
    String[] parts = payloadFilenameMessage.split(":");
    long payloadId = Long.parseLong(parts[0]);
    String filename = parts[1];
    filePayloadFilenames.put(payloadId, filename);
    return payloadId;
  }

  private void processFilePayload(long payloadId) {
    // BYTES and FILE could be received in any order, so we call when either the BYTES or the FILE
    // payload is completely received. The file payload is considered complete only when both have
    // been received.
    Payload filePayload = completedFilePayloads.get(payloadId);
    String filename = filePayloadFilenames.get(payloadId);
    if (filePayload != null && filename != null) {
      completedFilePayloads.remove(payloadId);
      filePayloadFilenames.remove(payloadId);

      // Get the received file (which will be in the Downloads folder)
      // Because of https://developer.android.com/preview/privacy/scoped-storage, we are not
      // allowed to access filepaths from another process directly. Instead, we must open the
      // uri using our ContentResolver.
      Uri uri = filePayload.asFile().asUri();
      try {
        // Copy the file to a new location.
        InputStream in = context.getContentResolver().openInputStream(uri);
        copyStream(in, new FileOutputStream(new File(context.getCacheDir(), filename)));
      } catch (IOException e) {
        // Log the error.
      } finally {
        // Delete the original file.
        context.getContentResolver().delete(uri, null, null);
      }
    }
  }

  // add removed tag back to fix b/183037922
  private void processFilePayload2(long payloadId) {
    // BYTES and FILE could be received in any order, so we call when either the BYTES or the FILE
    // payload is completely received. The file payload is considered complete only when both have
    // been received.
    Payload filePayload = completedFilePayloads.get(payloadId);
    String filename = filePayloadFilenames.get(payloadId);
    if (filePayload != null && filename != null) {
      completedFilePayloads.remove(payloadId);
      filePayloadFilenames.remove(payloadId);

      // Get the received file (which will be in the Downloads folder)
      if (VERSION.SDK_INT >= VERSION_CODES.Q) {
        // Because of https://developer.android.com/preview/privacy/scoped-storage, we are not
        // allowed to access filepaths from another process directly. Instead, we must open the
        // uri using our ContentResolver.
        Uri uri = filePayload.asFile().asUri();
        try {
          // Copy the file to a new location.
          InputStream in = context.getContentResolver().openInputStream(uri);
          copyStream(in, new FileOutputStream(new File(context.getCacheDir(), filename)));
        } catch (IOException e) {
          // Log the error.
        } finally {
          // Delete the original file.
          context.getContentResolver().delete(uri, null, null);
        }
      } else {
        File payloadFile = filePayload.asFile().asJavaFile();

        // Rename the file.
        payloadFile.renameTo(new File(payloadFile.getParentFile(), filename));
      }
    }
  }

  @Override
  public void onPayloadTransferUpdate(String endpointId, PayloadTransferUpdate update) {
    if (update.getStatus() == PayloadTransferUpdate.Status.SUCCESS) {
      long payloadId = update.getPayloadId();
      Payload payload = incomingFilePayloads.remove(payloadId);
      completedFilePayloads.put(payloadId, payload);
      if (payload.getType() == Payload.Type.FILE) {
        processFilePayload(payloadId);
      }
    }
  }

  /** Copies a stream from one location to another. */
  private static void copyStream(InputStream in, OutputStream out) throws IOException {
    try {
      byte[] buffer = new byte[1024];
      int read;
      while ((read = in.read(buffer)) != -1) {
        out.write(buffer, 0, read);
      }
      out.flush();
    } finally {
      in.close();
      out.close();
    }
  }
}

स्ट्रीम

स्ट्रीम पेलोड तब इस्तेमाल किए जा सकते हैं, जब आपको ज़्यादा डेटा भेजना हो जैसे, ऑडियो स्ट्रीम. STREAM पेलोड बनाएं Payload.fromStream() पर कॉल करने के लिए, InputStream या ParcelFileDescriptor. उदाहरण के लिए:

URL url = new URL("https://developers.google.com/nearby/connections/android/exchange-data");
Payload streamPayload = Payload.fromStream(url.openStream());
Nearby.getConnectionsClient(context).sendPayload(toEndpointId, streamPayload);

पैसे पाने वाले व्यक्ति की ओर से, onPayloadTransferUpdate कॉलबैक में payload.asStream().asInputStream() या payload.asStream().asParcelFileDescriptor() पर कॉल करें:

static class ReceiveStreamPayloadCallback extends PayloadCallback {
  private final SimpleArrayMap<Long, Thread> backgroundThreads = new SimpleArrayMap<>();

  private static final long READ_STREAM_IN_BG_TIMEOUT = 5000;

  @Override
  public void onPayloadTransferUpdate(String endpointId, PayloadTransferUpdate update) {
    if (backgroundThreads.containsKey(update.getPayloadId())
        && update.getStatus() != PayloadTransferUpdate.Status.IN_PROGRESS) {
      backgroundThreads.get(update.getPayloadId()).interrupt();
    }
  }

  @Override
  public void onPayloadReceived(String endpointId, Payload payload) {
    if (payload.getType() == Payload.Type.STREAM) {
      // Read the available bytes in a while loop to free the stream pipe in time. Otherwise, the
      // bytes will block the pipe and slow down the throughput.
      Thread backgroundThread =
          new Thread() {
            @Override
            public void run() {
              InputStream inputStream = payload.asStream().asInputStream();
              long lastRead = SystemClock.elapsedRealtime();
              while (!Thread.interrupted()) {
                if ((SystemClock.elapsedRealtime() - lastRead) >= READ_STREAM_IN_BG_TIMEOUT) {
                  Log.e("MyApp", "Read data from stream but timed out.");
                  break;
                }

                try {
                  int availableBytes = inputStream.available();
                  if (availableBytes > 0) {
                    byte[] bytes = new byte[availableBytes];
                    if (inputStream.read(bytes) == availableBytes) {
                      lastRead = SystemClock.elapsedRealtime();
                      // Do something with is here...
                    }
                  } else {
                    // Sleep or just continue.
                  }
                } catch (IOException e) {
                  Log.e("MyApp", "Failed to read bytes from InputStream.", e);
                  break;
                } // try-catch
              } // while
            }
          };
      backgroundThread.start();
      backgroundThreads.put(payload.getId(), backgroundThread);
    }
  }
}

एक से ज़्यादा पेलोड के साथ ऑर्डर करना

एक ही तरह के पेलोड उसी क्रम में आते हैं जिस क्रम में वे भेजे गए थे, हालांकि, इस बात की कोई गारंटी नहीं है कि प्रॉडक्ट के पेलोड के बीच ऑर्डर को बनाए रखा जाएगा अलग-अलग तरह के हैं. उदाहरण के लिए, अगर भेजने वाला व्यक्ति FILE पेलोड भेजता है, तो BYTE पेलोड, पाने वाले व्यक्ति को पहले BYTE पेलोड मिल सकता है. इसके बाद, FILE पेलोड.

प्रोग्रेस से जुड़े अपडेट

onPayloadTransferUpdate() तरीका, आने वाले और भेजे जाने वाले पेलोड, दोनों की प्रोग्रेस के बारे में अपडेट देता है. दोनों ही मामलों में, इसकी मदद से उपयोगकर्ता को यह दिखाया जा सकता है कि ऐप्लिकेशन ट्रांसफ़र हुआ है या नहीं. जैसे, प्रोग्रेस बार में. इनकमिंग पेलोड के लिए, अपडेट यह भी बताते हैं कि नया डेटा कब मिला है.

नीचे दिया गया सैंपल कोड, कैंपेन की प्रोग्रेस को दिखाने का एक तरीका बताता है सूचनाओं के ज़रिए इनकमिंग और आउटगोइंग पेलोड:

class ReceiveWithProgressCallback extends PayloadCallback {
  private final SimpleArrayMap<Long, NotificationCompat.Builder> incomingPayloads =
      new SimpleArrayMap<>();
  private final SimpleArrayMap<Long, NotificationCompat.Builder> outgoingPayloads =
      new SimpleArrayMap<>();

  NotificationManager notificationManager =
      (NotificationManager) context.getSystemService(Context.NOTIFICATION_SERVICE);

  private void sendPayload(String endpointId, Payload payload) {
    if (payload.getType() == Payload.Type.BYTES) {
      // No need to track progress for bytes.
      return;
    }

    // Build and start showing the notification.
    NotificationCompat.Builder notification = buildNotification(payload, /*isIncoming=*/ false);
    notificationManager.notify((int) payload.getId(), notification.build());

    // Add it to the tracking list so we can update it.
    outgoingPayloads.put(payload.getId(), notification);
  }

  private NotificationCompat.Builder buildNotification(Payload payload, boolean isIncoming) {
    NotificationCompat.Builder notification =
        new NotificationCompat.Builder(context)
            .setContentTitle(isIncoming ? "Receiving..." : "Sending...");
    boolean indeterminate = false;
    if (payload.getType() == Payload.Type.STREAM) {
      // We can only show indeterminate progress for stream payloads.
      indeterminate = true;
    }
    notification.setProgress(100, 0, indeterminate);
    return notification;
  }

  @Override
  public void onPayloadReceived(String endpointId, Payload payload) {
    if (payload.getType() == Payload.Type.BYTES) {
      // No need to track progress for bytes.
      return;
    }

    // Build and start showing the notification.
    NotificationCompat.Builder notification = buildNotification(payload, true /*isIncoming*/);
    notificationManager.notify((int) payload.getId(), notification.build());

    // Add it to the tracking list so we can update it.
    incomingPayloads.put(payload.getId(), notification);
  }

  @Override
  public void onPayloadTransferUpdate(String endpointId, PayloadTransferUpdate update) {
    long payloadId = update.getPayloadId();
    NotificationCompat.Builder notification = null;
    if (incomingPayloads.containsKey(payloadId)) {
      notification = incomingPayloads.get(payloadId);
      if (update.getStatus() != PayloadTransferUpdate.Status.IN_PROGRESS) {
        // This is the last update, so we no longer need to keep track of this notification.
        incomingPayloads.remove(payloadId);
      }
    } else if (outgoingPayloads.containsKey(payloadId)) {
      notification = outgoingPayloads.get(payloadId);
      if (update.getStatus() != PayloadTransferUpdate.Status.IN_PROGRESS) {
        // This is the last update, so we no longer need to keep track of this notification.
        outgoingPayloads.remove(payloadId);
      }
    }

    if (notification == null) {
      return;
    }

    switch (update.getStatus()) {
      case PayloadTransferUpdate.Status.IN_PROGRESS:
        long size = update.getTotalBytes();
        if (size == -1) {
          // This is a stream payload, so we don't need to update anything at this point.
          return;
        }
        int percentTransferred =
            (int) (100.0 * (update.getBytesTransferred() / (double) update.getTotalBytes()));
        notification.setProgress(100, percentTransferred, /* indeterminate= */ false);
        break;
      case PayloadTransferUpdate.Status.SUCCESS:
        // SUCCESS always means that we transferred 100%.
        notification
            .setProgress(100, 100, /* indeterminate= */ false)
            .setContentText("Transfer complete!");
        break;
      case PayloadTransferUpdate.Status.FAILURE:
      case PayloadTransferUpdate.Status.CANCELED:
        notification.setProgress(0, 0, false).setContentText("Transfer failed");
        break;
      default:
        // Unknown status.
    }

    notificationManager.notify((int) payloadId, notification.build());
  }
}