Ponto de entrada para a API Navigation. Use os métodos estáticos nessa classe para conseguir uma referência para
Navigator
.
Resumo de classes aninhadas
@interface | NavigationApi.ErrorCode | Um ErrorCode é um código de status retornado por getNavigator(Activity, NavigatorListener)
e getNavigator(Application, NavigatorListener) quando um Navigator não foi
recebido. |
|
Interface | NavigationApi.NavigatorListener | Registra um NavigatorListener com getNavigator(Activity, NavigatorListener) para ser
notificado sobre o status desse Navigator . |
|
Interface | NavigationApi.OnTermsResponseListener | Registre um OnTermsResponseListener com showTermsAndConditionsDialog(Activity, String, OnTermsResponseListener) para receber uma notificação quando o usuário aceitar ou recusar os Termos e
Condições. |
Resumo do método público
estático booleano |
areTermsAccepted(candidatura)
Retorna
true se o usuário já aceitou os Termos e Condições de navegação do Google. |
estático void |
cleanup()
Limpa o estado interno dos componentes do NavSDK.
|
sincronizado estático ForegroundServiceManager |
getForegroundServiceManager(aplicativo do aplicativo)
Recebe a instância
ForegroundServiceManager singleton. |
estático String |
getNavSDKVersion()
Retorna a versão atual do NavSDK.
|
estático void |
getNavigator(aplicativo do aplicativo, callback NavigationApi.NavigatorListener)
Recebe a instância de
Navigator . |
estático void |
getNavigator(atividade da atividade, callback NavigationApi.NavigatorListener, TermsAndConditionsCheckOption termosCheck)
Recebe a instância de
Navigator . |
estático void |
getNavigator(atividade de atividade, callback NavigationApi.NavigatorListener)
É equivalente a
getNavigator(activity, callback, {@link
TermsAndConditionsCheckOption#ENABLED} . |
estático void |
getNavigatorNoToS(aplicativo de aplicativo, callback NavigationApi.NavigatorListener)
Recebe a instância de
Navigator . |
estático RoadSnappedLocationProvider |
getRoadSnappedLocationProvider(aplicativo)
Recebe uma instância do
RoadSnappedLocationProvider , que pode ser usada para se inscrever em locais de usuários ajustados pela via. |
estático NavigationTransactionRecorder |
getTransactionRecorder(aplicativo)
Recebe uma instância do
NavigationTransactionRecorder , que pode ser usada para registrar transações relacionadas à navegação. |
sincronizado estático void |
initForegroundServiceManager(aplicativo do aplicativo, notificationId de número inteiro, string defaultMessage, provedor de NotificationContentProvider)
Inicializa a instância do
ForegroundServiceManager com argumentos fornecidos. |
estático void |
resetTermsAccepted(aplicativo do aplicativo)
Redefina os Termos e Condições para testes.
|
estático void |
showTermsAndConditionsDialog(atividade da atividade, string companyName, título da string, listener NavigationApi.OnTermsResponseListener)
Exibe uma caixa de diálogo que direciona o usuário a aceitar os Termos e Condições de Navegação do Google, usando a aparência padrão.
|
estático void |
showTermsAndConditionsDialog(atividade da atividade, string companyName, título da string, TermsAndConditionsUIParams uiParams, NavigationApi.OnTermsResponseListener listener, TermsAndConditionsCheckOption termosAndConditionsCheckOption)
Exibe uma caixa de diálogo que orienta o usuário a aceitar os Termos e Condições de Navegação do Google.
|
estático void |
showTermsAndConditionsDialog(atividade da atividade, string companyName, listener NavigationApi.OnTermsResponseListener)
Exibe uma caixa de diálogo que orienta o usuário a aceitar os Termos e Condições de Navegação do Google,
usando o título e a aparência padrão.
|
Resumo do método herdado
Métodos públicos
público estático booleano areTermsAccepted (aplicativo do aplicativo)
Retorna true
se o usuário já aceitou os Termos e Condições de navegação do Google.
Você pode usar isso para verificar se precisa exibir a tela de termos mais cedo no aplicativo, em vez de quando o usuário estiver prestes a navegar para algum lugar. Por exemplo, pode ser apropriado verificar esse valor quando o app estiver mostrando outros Termos e Condições, para que o usuário possa aceitar todos os termos e condições necessários para o app em uma tarefa.
Parâmetros
aplicativo | o aplicativo atual |
---|
Retorna
true
se os termos tiverem sido aceitos pelo usuário. Caso contrário,false
.
public estático void limpeza ()
Limpa o estado interno dos componentes do NavSDK. Se um navegador atual existir, a orientação será interrompida e desativada. Nenhuma chamada futura de orientação pode ser feita a partir deste Navegador. Chame esse método para recuperar a memória quando o app não precisar mais do Navigator e tiver destruído todas as referências a ele. Se o app exigir um Navigator após essa chamada, use getNavigator() para criar um novo. Observação: a criação de um novo Navigator leva tempo. Considere como um atraso afetaria o desempenho do seu app em comparação com os benefícios da memória recuperada.
público estático sincronizado ForegroundServiceManager getForegroundServiceManager (aplicativo de aplicativo)
Recebe a instância ForegroundServiceManager
singleton. Se initForegroundServiceManager(Application, Integer, String, NotificationContentProvider)
não for chamado antes de getForegroundServiceManager(Application)
, um provedor de ID, mensagem e notificação padrão será usado.
Parâmetros
aplicativo | o Application atual
|
---|
public Static String getNavSDKVersion ()
Retorna a versão atual do NavSDK.
public estático void getNavigator (Aplicativo de aplicativo, callback de NavigationApi.NavigatorListener)
Recebe a instância de Navigator
.
Se o usuário ainda não tiver concordado com os Termos e Condições, o callback será acionado imediatamente com o código de erro TERMS_NOT_ACCEPTED
.
O Navigator é um Singleton. Se você chamar esse método várias vezes, cada chamada vai retornar o mesmo Navigator.
Parâmetros
aplicativo | o Application atual |
---|---|
callback | Um callback que será acionado quando a Navigator estiver pronta ou quando ocorrer um erro
|
public estático void getNavigator (atividade de atividade, callback de NavigationApi.NavigatorListener, TermsAndConditionsCheckOption aos termos da verificação)
Recebe a instância de Navigator
.
Se o usuário ainda não tiver concordado com os Termos e Condições, essa chamada mostrará uma caixa de diálogo exortando o usuário a obedecer às regulamentações locais.
Se termsCheck
for ENABLED
, a caixa de diálogo também conterá um link para os Termos e Condições do SDK de navegação. O callback
será chamado com um erro TERMS_NOT_ACCEPTED
se o usuário não aceitar esses termos.
O Navigator é um Singleton. Se você chamar esse método várias vezes, cada chamada vai retornar o mesmo Navigator.
Parâmetros
atividade | a Activity para mostrar a caixa de diálogo de Termos e Condições, se ela ainda não tiver sido aceita; |
---|---|
callback | Um callback que será acionado quando a Navigator estiver pronta ou quando ocorrer um erro |
termsCheck | que indica se a verificação dos Termos e Condições deve ser ignorada |
public Static void getNavigator (Atividade da atividade, callback NavigationApi.NavigatorListener)
É equivalente a getNavigator(activity, callback, {@link
TermsAndConditionsCheckOption#ENABLED}
.
Parâmetros
atividade | |
---|---|
callback |
public estático void getNavigatorNoToS (Aplicativo de aplicativo, callback de NavigationApi.NavigatorListener)
Recebe a instância de Navigator
.
Ignora os termos e condições.
O Navigator é um Singleton. Se você chamar esse método várias vezes, cada chamada vai retornar o mesmo Navigator.
Parâmetros
aplicativo | o Application atual. |
---|---|
callback | um callback que será acionado quando a Navigator estiver pronta ou quando ocorrer um erro.
|
public estático RoadSnappedLocationProvider getRoadSnappedLocationProvider (Aplicativo do aplicativo)
Recebe uma instância do RoadSnappedLocationProvider
, que pode ser usada para se inscrever em locais de usuários ajustados pela via. Inscrever-se para receber atualizações de localização por meio da rota pode causar consumo de bateria ou coleta não intencional de dados de local do usuário se o dispositivo estiver em execução em segundo plano.
É preciso conseguir um Navigator
antes de chamar esse método. Caso contrário, ele retornará null
.
Parâmetros
aplicativo | o Application atual
|
---|
public estático NavigationTransactionRecorder getTransactionRecorder (Aplicativo de aplicativo)
Recebe uma instância do NavigationTransactionRecorder
, que pode ser usada para registrar transações relacionadas à navegação.
Use essa classe apenas se sua empresa for faturada pelo Google por transação.
É preciso conseguir um Navigator
antes de chamar esse método. Caso contrário, ele retornará null
.
Parâmetros
aplicativo | o Application atual
|
---|
public estático sync void initForegroundServiceManager (aplicativo de aplicativo, notificationId de número inteiro, string defaultMessage, provedor NotificationContentProvider)
Inicializa a instância do ForegroundServiceManager
com argumentos fornecidos.
Ele só deverá ser chamado se você quiser modificar qualquer um dos parâmetros padrão. Caso contrário, chame getForegroundServiceManager(Application)
diretamente. Esse método só pode ser chamado uma vez e precisa ser chamado antes de getForegroundServiceManager(Application)
.
Parâmetros
aplicativo | o Application atual |
---|---|
notificationId | o ID da notificação persistente |
defaultMessage | a mensagem padrão a ser mostrada se um provider não for especificado |
provider | uma implementação de NotificationContentProvider
|
public estático void resetTermsAccepted (Aplicativo de inscrição)
Redefina os Termos e Condições para testes. Adicione uma chamada a ele antes de qualquer chamada para NavigationApi
se quiser testar a caixa de diálogo de Termos e Condições.
Parâmetros
aplicativo | o aplicativo atual |
---|
public estático void showTermsAndConditionsDialog (atividade da atividade, string companyName, título da string, listener NavigationApi.OnTermsResponseListener)
Exibe uma caixa de diálogo que direciona o usuário a aceitar os Termos e Condições de Navegação do Google, usando a aparência padrão.
Parâmetros
atividade | |
---|---|
companyName | |
título | |
listener |
public estático void showTermsAndConditionsDialog (Atividade da atividade, String companyName, Título da string, TermsAndConditionsUIParams uiParams, NavigationApi.OnTermsResponseListener listener, TermsAndConditionsCheckOption TermsAndConditionsCheckOption)
Exibe uma caixa de diálogo que orienta o usuário a aceitar os Termos e Condições de Navegação do Google. Se especificado, o listener será chamado na linha de execução de IU, indicando se o usuário aceitou os termos e condições.
A caixa de diálogo vai aparecer mesmo que o usuário já tenha aceitado o convite. Chame essa API apenas se areTermsAccepted(Application)
for false
, porque um usuário não pode recusar os Termos e Condições.
Parâmetros
atividade | o Activity em que a caixa de diálogo será mostrada |
---|---|
companyName | o nome da sua empresa, que será exibido na caixa de diálogo de Termos e Condições |
título | o título da caixa de diálogo. Se o valor for nulo, a caixa de diálogo vai usar o título padrão. |
uiParams | os parâmetros usados para personalizar a aparência da caixa de diálogo. Se o valor for nulo, a aparência padrão será usada. |
listener | um retorno de chamada opcional que será disparado quando o usuário aceitar ou recusar os Termos e Condições |
termsAndConditionsCheckOption | o TermsAndConditionsCheckOption que especifica opções para verificar termos e condições
|
public estático void showTermsAndConditionsDialog (Atividade da atividade, String companyName, listener NavigationApi.OnTermsResponseListener)
Exibe uma caixa de diálogo que orienta o usuário a aceitar os Termos e Condições de Navegação do Google, usando o título e a aparência padrão.
Parâmetros
atividade | |
---|---|
companyName | |
listener |