Publicar e assinar

A API Nearby Messages é de publicação/assinatura que permite que dispositivos por e a troca de pequenos payloads de dados. Quando um dispositivo publica uma mensagem, dispositivos podem receber a mensagem. A mensagem deve ser mantida bem pequena para manter um bom desempenho. Este serviço não se destina à troca de valores objetos, como fotos e vídeos.

O conjunto de dispositivos próximos é determinado pela troca de pequenos tokens por Bluetooth e áudio quase ultrassônico (audível). Quando um dispositivo detecta um token de um dispositivo próximo, ele envia o token para o servidor do Nearby Messages para validá-los e verificar se há alguma mensagem a ser entregue para os atual de assinaturas.

Um aplicativo pode controlar o conjunto de mídias usadas para descoberta de dispositivos e se as mídias são usadas para transmitir tokens e/ou procurar tokens. Por padrão, a transmissão e a verificação são feitas em todos os meios. Afazeres descoberta em um subconjunto ou mídias e para controlar a transmissão ou a verificação, é necessário transmitir parâmetros adicionais ao criar publicações e assinaturas.

Essa biblioteca pode ser executada no iOS 7 ou superior e criada com o SDK do iOS 8.

Como criar um gerenciador de mensagens

Esse código cria um objeto gerenciador de mensagens que permite publicar e se inscrever. A troca de mensagens não está autenticada, por isso você deve fornecer uma chave de API pública para iOS. Você pode criar uma usando a entrada do Google Developers Console para seu projeto.

Objective-C

#import <GNSMessages.h>

GNSMessageManager *messageManager =
    [[GNSMessageManager alloc] initWithAPIKey:@"API_KEY"];

Swift

let messageManager = GNSMessageManager(APIKey: "API_KEY")

Publicando uma mensagem

Este snippet de código demonstra a publicação de uma mensagem com um nome. A publicação vai ficar ativa enquanto o objeto existir. Para interromper publicar, libere o objeto de publicação.

Objective-C

id<GNSPublication> publication =
    [messageManager publicationWithMessage:[GNSMessage messageWithContent:[name dataUsingEncoding:NSUTF8StringEncoding]]];

Swift

let publication =
    messageManager.publication(with: GNSMessage(content: name.data(using: .utf8)))

Como se inscrever em mensagens

Este snippet de código demonstra a inscrição em todos os nomes compartilhados pelo snippet da publicação anterior. A assinatura ficará ativa desde que o de assinatura já existe. Para interromper, libere a assinatura objeto.

O gerenciador de mensagens encontradas é chamado quando há dispositivos por perto publicando e mensagens são descobertas. O gerenciador de mensagens perdidas é chamado quando uma mensagem não é mais observado (o dispositivo ficou fora de alcance ou não está mais publicando o ).

Objective-C

id<GNSSubscription> subscription =
    [messageManager subscriptionWithMessageFoundHandler:^(GNSMessage *message) {
      // Add the name to a list for display
    }
    messageLostHandler:^(GNSMessage *message) {
      // Remove the name from the list
    }];

Swift

let subscription =
    messageManager.subscription(messageFoundHandler: { (message: GNSMessage?) in
      // Add the name to a list for display
    },
    messageLostHandler: { (message: GNSMessage?) in
      // Remove the name from the list
    })

Meios de descoberta

Por padrão, ambos os meios (áudio e Bluetooth) serão usados para descobrir por perto e os dois meios vão transmitir e verificar. Para certos casos, você está necessário para adicionar as seguintes entradas ao Info.plist do app:

  • Se o app fizer a leitura usando áudio, adicione NSMicrophoneUsageDescription, que é uma string descrevendo por que você usará o microfone. Por exemplo, "O microfone detecta tokens anônimos de dispositivos próximos."

  • Se o app transmitir usando BLE, adicione NSBluetoothPeripheralUsageDescription, que é uma string que descreve por que você anunciará no BLE. Por exemplo, "Um token anônimo é anunciado via Bluetooth para descobrir dispositivos próximos."

Em alguns casos, seu app pode precisar usar somente uma das mídias talvez não precise fazer a transmissão e a verificação nesse meio.

Por exemplo, um aplicativo projetado para se conectar a um conversor que é A transmissão em áudio só precisa verificar o áudio para detectá-lo. O seguinte O snippet mostra como publicar uma mensagem nesse conversor usando somente áudio verificação para descoberta:

Objective-C

id<GNSPublication> publication = [messageManager publicationWithMessage:message
    paramsBlock:^(GNSPublicationParams *params) {
      params.strategy = [GNSStrategy strategyWithParamsBlock:^(GNSStrategyParams *params) {
        params.discoveryMediums = kGNSDiscoveryMediumsAudio;
        params.discoveryMode = kGNSDiscoveryModeScan;
      }];
    }];

Swift

let publication = messageManager.publication(with: message,
    paramsBlock: { (params: GNSPublicationParams?) in
      guard let params = params else { return }
      params.strategy = GNSStrategy(paramsBlock: { (params: GNSStrategyParams?) in
        guard let params = params else { return }
        params.discoveryMediums = .audio
        params.discoveryMode = .scan
      })
    })

Como ativar a geração de registros de depuração

O registro de depuração imprime eventos internos significativos no console que podem ser útil para rastrear problemas que você pode encontrar ao integrar o Nearby Mensagens no seu app. Solicitaremos esses registros se você entrar em contato conosco suporte técnico.

Ative-o antes de criar um gerenciador de mensagens. Esse snippet de código mostra como ativar a geração de registros de depuração:

Objective-C

[GNSMessageManager setDebugLoggingEnabled:YES];

Swift

GNSMessageManager.setDebugLoggingEnabled(true)

Rastrear o estado de permissão do Nearby

O consentimento do usuário é necessário para ativar a descoberta de dispositivos. Isso é indicado pelo Estado da permissão do Nearby. Na primeira chamada para criar uma publicação ou assinatura, uma caixa de diálogo de consentimento é exibida. Se o usuário não consentimento, a descoberta de dispositivos não funcionará. Nesse caso, seu app deve mostrar para lembrar ao usuário que a descoberta de dispositivos está desativada. A permissão estado é armazenado em NSUserDefaults.

O snippet a seguir demonstra a inscrição no estado de permissão. A o manipulador alterado de estado de permissão é chamado sempre que o estado é alterado e é não é chamado pela primeira vez até que o usuário tenha dado ou negado a permissão. Libere o objeto de permissão para interromper a assinatura.

Objective-C

GNSPermission *nearbyPermission = [[GNSPermission alloc] initWithChangedHandler:^(BOOL granted) {
  // Update the UI here
}];

Swift

let nearbyPermission = GNSPermission(changedHandler: { (granted: Bool) in
  // Update the UI here
})

Seu app pode oferecer ao usuário uma maneira de mudar o estado de permissão. para exemplo, usando um botão em uma página de configurações.

Confira um exemplo de como receber e definir o estado da permissão.

Objective-C

BOOL permissionState = [GNSPermission isGranted];
[GNSPermission setGranted:!permissionState];  // toggle the state

Swift

let permissionState = GNSPermission.isGranted()
GNSPermission.setGranted(!permissionState)  // toggle the state

Monitorando as configurações do usuário que afetam o Por perto

Se o usuário tiver negado a permissão de acesso ao microfone ou ao Bluetooth, ou desativou o Bluetooth, o recurso "Por perto" não funcionará ou não funcionará. Seu app deve mostrar uma mensagem nesses casos, alertando o usuário de que o endereço as operações. O snippet a seguir mostra como acompanhar o status dessas configurações do usuário transmitindo gerenciadores ao criar a mensagem administrador:

Objective-C

GNSMessageManager *messageManager = [[GNSMessageManager alloc]
    initWithAPIKey:API_KEY
       paramsBlock:^(GNSMessageManagerParams *params) {
         params.microphonePermissionErrorHandler = ^(BOOL hasError) {
           // Update the UI for microphone permission
         };
         params.bluetoothPowerErrorHandler = ^(BOOL hasError) {
           // Update the UI for Bluetooth power
         };
         params.bluetoothPermissionErrorHandler = ^(BOOL hasError) {
           // Update the UI for Bluetooth permission
         };
}];

Swift

let messageManager = GNSMessageManager(
         APIKey: API_KEY,
    paramsBlock: { (params: GNSMessageManagerParams?) in
      guard let params = params else { return }
      params.microphonePermissionErrorHandler = { (hasError: Bool) in
        // Update the UI for microphone permission
      }
      params.bluetoothPowerErrorHandler = { (hasError: Bool) in
        // Update the UI for Bluetooth power
      }
      params.bluetoothPermissionErrorHandler = { (hasError: Bool) in
        // Update the UI for Bluetooth permission
      }
    })

Substituir a caixa de diálogo de permissão do Nearby

Dependendo dos parâmetros que você transmitir para suas publicações e assinaturas, O iOS pode pedir várias permissões antes de permitir que o "Por perto" funcione. Para instância padrão, a estratégia padrão detecta dados transmitidos em áudio, e o iOS vai pedir permissão para usar o microfone. Nesses casos, O recurso "Por perto" mostrará uma "simulação" caixa de diálogo que explica por que o usuário está sendo solicitado para dar permissão.

Se você quiser fornecer uma "simulação" personalizada defina a configuração parâmetro permissionRequestHandler a um bloco personalizado na publicação ou parâmetros de assinatura. Seu bloco personalizado precisa chamar o método permissionHandler depois que o usuário tiver respondido. O snippet a seguir mostra como fazer isso. de uma publicação:

Objective-C

id<GNSPublication> publication =
    [messageManager publicationWithMessage:[GNSMessage messageWithContent:[name dataUsingEncoding:NSUTF8StringEncoding]]
                               paramsBlock:^(GNSPublicationParams *params) {
                                 params.permissionRequestHandler = ^(GNSPermissionHandler permissionHandler) {
                                   // Show your custom dialog here.
                                   // Don't forget to call permissionHandler() with YES or NO when the user dismisses it.
                                 };
                               }];

Swift

let publication =
    messageManager.publication(with: GNSMessage(content: name.data(using: .utf8)),
        paramsBlock: { (params: GNSPublicationParams?) in
          guard let params = params else { return }
          params.permissionRequestHandler = { (permissionHandler: GNSPermissionHandler?) in
            // Show your custom dialog here.
            // Don't forget to call permissionHandler() with true or false when the user dismisses it.
          }
        })

Operação em segundo plano

Publicações e assinaturas que usam BLE para descoberta de dispositivos podem funcionar na plano de fundo. Veja algumas coisas que você precisa considerar ao decidir usar modo de segundo plano:

  • Operações em segundo plano precisam usar somente mídia BLE. o áudio não é compatível.
  • Há um custo de bateria adicional para o BLE em segundo plano. O custo é baixo, mas você deve medi-la antes de decidir usar o modo de segundo plano.
  • O iOS vai pedir permissão ao usuário para anunciar via BLE em segundo plano.

Para adicionar o modo de segundo plano a uma publicação ou assinatura, siga estas instruções etapas:

  • Ative o modo de segundo plano e somente BLE na sua publicação ou assinatura: transmitindo um objeto GNSStrategy configurado corretamente. O snippet a seguir mostra como fazer isso para uma assinatura:

    Objective-C

    id<GNSSubscription> subscription =
    [messageManager subscriptionWithMessageFoundHandler:^(GNSMessage *message) {
      // Add the name to a list for display
    }
    messageLostHandler:^(GNSMessage *message) {
      // Remove the name from the list
    }
    paramsBlock:^(GNSSubscriptionParams *params) {
      params.strategy = [GNSStrategy strategyWithParamsBlock:^(GNSStrategyParams *params) {
        params.allowInBackground = YES;
        params.discoveryMediums = kGNSDiscoveryMediumsBLE;
      }];
    }];

    Swift

    let subscription =
    messageManager.subscription(messageFoundHandler: { (message: GNSMessage?) in
      // Add the name to a list for display
    },
    messageLostHandler: { (message: GNSMessage?) in
      // Remove the name from the list
    },
    paramsBlock:{ (params: GNSSubscriptionParams?) in
      guard let params = params else { return }
      params.strategy = GNSStrategy(paramsBlock: { (params: GNSStrategyParams?) in
        guard let params = params else { return }
        params.allowInBackground = true
        params.discoveryMediums = .BLE
      })
    })

  • Adicione estas entradas ao Info.plist do app:

    • UIBackgroundModes entradas:

      • bluetooth-central para verificação de BLE em segundo plano. Somente necessário quando o modo de descoberta inclui a verificação. que faz por padrão.
      • bluetooth-peripheral para publicidade de BLE em segundo plano. Necessário somente quando o modo de descoberta inclui transmissão; que faz por padrão.

    • String NSBluetoothPeripheralUsageDescription descrevendo o motivo você anunciará no BLE. Por exemplo, "Um token anônimo é anunciado via Bluetooth para descobrir dispositivos próximos." Consulte Documentação da Apple para mais detalhes.

  • Seu app pode ser encerrado a qualquer momento pelo sistema em segundo plano. Se o modo de segundo plano é uma configuração que pode ser ativada ou desativada pelo usuário, pela app precisa fazer o seguinte:

    • Salve o valor do modo de segundo plano em NSUserDefaults sempre que o usuário a alterar.
    • Na inicialização, leia pelo NSUserDefaults e restaure o Por perto publicações e/ou assinaturas se o modo em segundo plano estiver ativado.

Notificações em segundo plano

Se você quiser que seu app notifique o usuário quando uma assinatura receber uma mensagem em segundo plano, é possível usar notificações locais.

Siga estas etapas para adicioná-los ao seu app:

  • Registrar-se para receber notificações locais na inicialização:

    Objective-C

    if ([UIApplication instancesRespondToSelector:@selector(registerUserNotificationSettings:)]) {
  [[UIApplication sharedApplication] registerUserNotificationSettings:
      [UIUserNotificationSettings settingsForTypes:
          UIUserNotificationTypeAlert | UIUserNotificationTypeBadge | UIUserNotificationTypeSound
                                        categories:nil]];
}

    Swift

    UIApplication.shared.registerUserNotificationSettings(
    UIUserNotificationSettings(types: [.alert, .badge, .sound], categories: nil))

  • Envie uma notificação local no gerenciador de mensagens encontradas da sua assinatura:

    Objective-C

    GNSMessageHandler myMessageFoundHandler = ^(GNSMessage *message) {
    // Send a local notification if not in the foreground.
    if ([UIApplication sharedApplication].applicationState != UIApplicationStateActive) {
      UILocalNotification *localNotification = [[UILocalNotification alloc] init];
      localNotification.alertBody = @"Message received";
      [[UIApplication sharedApplication] presentLocalNotificationNow:localNotification];
    }
    // Process the new message...
  };

    Swift

    let myMessageFoundHandler: GNSMessageHandler = { (message: GNSMessage?) in
  // Send a local notification if not in the foreground.
  if UIApplication.shared.applicationState != .active {
    let localNotification = UILocalNotification()
    localNotification.alertBody = "Message received"
    UIApplication.shared.presentLocalNotificationNow(localNotification)
  }
  // Process the new message...
}