Módulo: Aplicativo
Índice
Funções
- cancelAttachmentDownloadAsync
- deleteActionLocalCacheAsync
- deleteDataFromTmpDirAsync
- dismissCurrentScreen
- downloadAttachmentAsync
- fetchTenantUserAttributeDetailsAsync
- fetchTenantUserProfilesAsync
- generateBase64ThumbnailAsync
- generateUUIDAsync
- getActionLocalCacheAsync
- getAppLocaleAsync
- getCalendarNameAsync
- getConversationDetailsAsync
- getCurrentDeviceLocationAsync
- getCurrentLocale
- getDeviceIdAsync
- getDeviceLocationAsync
- getFontSizeMultiplierAsync
- getForwardContextAsync
- getIsAppTimeFormat24HoursAsync
- getLocalizedStringsAsync
- getLocationAddressAsync
- getMapImageAsBase64Async
- getO365UserDetailsAsync
- getPackageCustomSettingsAsync
- getUsersDetailsAsync
- hideProgressBar
- isAttachmentDownloadingAsync
- isAuthenticationTyepSupportedAsync
- isTalkBackEnabledAsync
- logToReport
- openAttachmentImmersiveView
- openImmersiveViewForAttachmentList
- performAuthenticationAsync
- executarHTTPRequest
- Printf
- readDataFromTmpDirAsync
- readTalkBackMessage
- registerHardwareBackPressCallback
- saveDataInTmpDirAsync
- setNativeToolbarProperties
- setUserStrings
- showAttachmentPickerAsync
- showBarcodeScannerAsync
- showContactPickerAsync
- showDurationPickerAsync
- showImageImmersiveView
- showImagePickerAsync
- showLocationOnMap
- showNativeErrorMessage
- showPlacePickerAsync
- showProgressBar
- showQRcodeScannerAsync
- showUserProfileAsync
- startChatAsync
- updateActionLocalCacheAsync
- updateTenantUserProfileAsync
Funções
cancelAttachmentDownloadAsync
▸ cancelAttachmentDownloadAsync(anexo: KASAttachment, callback: function
): void
Cancelar uma operação de download enfileirada para um anexo
Uso de Exemplo
var attachmentsList = JSON.parse(form.properties[0].value);
for (var i = 0; i < attachmentsList.length; i++)
{
var attachmentItem = attachmentsList[i];
var attachment = KASClient.KASAttachment.fromJSON(attachmentItem);
KASClient.App.cancelAttachmentDownloadAsync(attachment);
}
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
anexo | KASAttachment | - |
retorno de chamada | function |
com param de erro – cadeia de caracteres de erro em caso de erro; nulo caso contrário |
Retorna:void
deleteActionLocalCacheAsync
▸ deleteActionLocalCacheAsync(actionLocalCacheProps: KASActionLocalCacheProp, callback: function
): void
Excluir o formulário de chave determinado do cache de dados local
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
actionLocalCacheProps | KASActionLocalCacheProp | propriedade de dados a serem excluídos do cache |
retorno de chamada | function |
retorno de chamada com parâmetros abaixo: ** @param o sucesso {boolean} indica se a atualização é bem-sucedida ou não ** @param {string} cadeia de caracteres de erro para o objeto KASError que contém código de erro e/ou descrição. |
Retorna:void
deleteDataFromTmpDirAsync
▸ deleteDataFromTmpDirAsync(filePath: string
, retorno de chamada: function
): void
Exclui o arquivo do armazenamento de cache temporário. Usado em conjunto com a API saveDataInTmpDirAsync para os arquivos armazenados usando essa API.
Uso de Exemplo
KASClient.App.deleteDataFromTmpDirAsync(filePath, function (success, error) {
if (error == null && success) {
// Action's code in success case
}
});
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
Filepath | string |
filepath que deve ser lido |
retorno de chamada | function |
com parâmetros abaixo: |
Retorna:void
dismissCurrentScreen
▸ dismissCurrentScreen(): void
Descartar a tela da Ação aberta atual (Criação, Resposta ou Resumo)
Retorna:void
downloadAttachmentAsync
▸ downloadAttachmentAsync(anexo: KASAttachment, callback: function
): void
Baixar o anexo especificado
Uso de Exemplo
var imageAttachment = new KASClient.KASAttachment();
imageAttachment.type = KASClient.KASAttachmentType.Image;
imageAttachment.serverPath = "<server path>";
imageAttachment.fileName = "<file name>";
KASClient.App.downloadAttachmentAsync(imageAttachment, function(downloadedAttachment, error){
if (!error) {
console.log(downloadedAttachment); //KASAttachment
}
});
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
anexo | KASAttachment | anexo com um caminho de servidor válido para baixar |
retorno de chamada | function |
retorno de chamada na conclusão do download com params abaixo * @param {KASAttachment} downloadedAttachment o anexo que foi baixado * @param {string} mensagem de erro em caso de erro, nulo caso contrário |
Retorna:void
fetchTenantUserAttributeDetailsAsync
▸ fetchTenantUserAttributeDetailsAsync(callback: function
): void
Busca os detalhes do atributo do locatário. O locatário da conversa no contexto será usado para isso.
Observação
A Ação deve pertencer ao mesmo locatário da conversa e o usuário precisa ser conectado a esse locatário para que essa api funcione
Uso de Exemplo
KASClient.App.fetchTenantUserAttributeDetailsAsync(function(tenantAttributes, error) {
if (error == null && tenantAttributes.length > 0) {
var tenantAttribute = tenantAttributes[0]; // TenantAttribute
console.log(tenantAttribute.id + " : " + tenantAttribute.name);
}
});
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
retorno de chamada | function |
com parâmetros abaixo: * @param {TenantAttribute[]} tenantAttributes matriz de atributos de locatário * @param {string} mensagem de erro em caso de erro, nulo caso contrário |
Retorna:void
fetchTenantUserProfilesAsync
▸ fetchTenantUserProfilesAsync(userIds: string
[], retorno de chamada: function
): void
Busca os atributos de locatário dos usuários determinados. O locatário da conversa no contexto será usado para isso.
Observação
A Ação deve pertencer ao mesmo locatário da conversa e o usuário precisa ser conectado a esse locatário para que essa api funcione
Uso de Exemplo
// Fetch current user's tenant profile
KASClient.App.fetchTenantUserProfilesAsync(null, function(tenantUserProfiles, error) {
if (error == null && tenantUserProfiles.length > 0) {
var userProfile = tenantUserProfiles[0]; // TenantUserProfile
var tenantAttributeData = userProfile.tenantAttributeDataList[0]; // TenantAttributeData
console.log(tenantAttributeData.attributeId + " : " + tenantAttributeData.attributeValue);
}
});
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
userIds | string [] |
matriz de IDs de usuário; se for nulo ou vazio, o perfil de locatário do usuário atual será buscado |
retorno de chamada | function |
com parâmetros abaixo: * @param {TenantUserProfile[]} tenantUserProfiles matriz de perfis de locatário dos usuários (pares id-value de atributo) * @param {string} mensagem de erro em caso de erro, nulo caso contrário |
Retorna:void
generateBase64ThumbnailAsync
▸ gereBase64ThumbnailAsync(localPath: string
, retorno de chamada: function
): void
Gera miniatura Base64 para uma imagem cujo localPath é dado
Uso de Exemplo
KASClient.App.generateBase64ThumbnailAsync(localPath, function (thumbnail, error) {
if (error == null && thumbnail != null) {
//use the thumbnail data and update required dom
}
});
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
Localpath | string |
localPath para a imagemAttachment cuja miniatura precisa ser gerada |
retorno de chamada | function |
com parâmetros abaixo: * @param {string} miniatura do valor base64 * @param {string} mensagem de erro em caso de erro, nulo caso contrário |
Retorna:void
generateUUIDAsync
▸ generateUUIDAsync(retorno de chamada: function
): void
Obtém o novo UUID
Uso de Exemplo
KASClient.App.generateUUIDAsync(function (uuid, error) {
console.log("generatedUUIDAsync", uuid);
...
});
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
retorno de chamada | function |
com parâmetros abaixo: * @param {string} uuid recém-gerado uuid * @param {string} mensagem de erro em caso de erro, nulo caso contrário |
Retorna:void
getActionLocalCacheAsync
▸ getActionLocalCacheAsync(actionLocalCacheProps: KASActionLocalCacheProp, callback: function
): void
Recupera a chave fornecida para o cache de dados local Valor é salvo no nível mencionado em KASActionLocalCacheProp de acordo
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
actionLocalCacheProps | KASActionLocalCacheProp | propriedade de dados a serem recuperados do cache |
retorno de chamada | function |
retorno de chamada com parâmetros abaixo: ** @param {KASActionLocalCacheProp} actionLocalCacheProps indica se a atualização é bem-sucedida ou não ** @param {string} cadeia de caracteres json de erro para o objeto KASError que contém código de erro e/ou descrição. |
Retorna:void
getAppLocaleAsync
▸ getAppLocaleAsync(retorno de chamada: function
): void
Obtém a localidade do aplicativo atual, o idioma no qual o aplicativo é renderizado, útil para localizar cadeias de caracteres do MiniApp
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
retorno de chamada | function |
com parâmetros abaixo: * @param A localidade {string} pode ser nula em caso de erro * @param {string} mensagem de erro em caso de erro, nulo caso contrário |
Retorna:void
getCalendarNameAsync
▸ getCalendarNameAsync(retorno de chamada: function
): void
Obtém a configuração atual do calendário do sistema. Isso é principalmente para o iOS identificar o nome do calendário definido na configuração do telefone, como gregoriano ou japonês ou budista.
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
retorno de chamada | function |
com parâmetros abaixo: * @param {string} calendarName pode ser nulo em caso de erro * @param {string} mensagem de erro em caso de erro, nulo caso contrário |
Retorna:void
getConversationDetailsAsync
▸ getConversationDetailsAsync(callback: function
): void
Obtém propriedades relacionadas à conversa
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
retorno de chamada | function |
com parâmetros abaixo: * @param Propriedades de conversa de resultado {KASConversationDetails} * @param {string} erro json string para o objeto KASError que contém código de erro e/ou descrição. |
Retorna:void
getCurrentDeviceLocationAsync
▸ getCurrentDeviceLocationAsync(callback: function
, canUseCachedLocation?: boolean
): void
Obtém o local do dispositivo atual
Uso de Exemplo
KASClient.App.getCurrentDeviceLocationAsync(function (location, error){
if(error != null) {
return;
}
//use location(KASLocation) as the device location
}, false);
Parâmetros:
Nome | Tipo | Valor padrão | Descrição |
---|---|---|---|
retorno de chamada | function |
- | com parâmetros abaixo: * @param O local {string} pode ser nulo em caso de erro * @param {string} mensagem de erro em caso de erro, nulo caso contrário |
Default value canUseCachedLocation |
boolean |
falso | (opcional, padrão se falso) se esse sinalizador for verdadeiro, a plataforma poderá optar por retornar um local armazenado em cache de até 30min de idade caso haja um erro ao buscar o local atual |
Retorna:void
getCurrentLocale
▸ getCurrentLocale(): string
Retorna:string
getDeviceIdAsync
▸ getDeviceIdAsync(retorno de chamada: function
): void
Obtém deviceId
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
retorno de chamada | function |
com parâmetros abaixo: * @param {string} deviceId recebeu do serviço de inteiro * @param {string} mensagem de erro em caso de erro, nulo caso contrário |
Retorna:void
getDeviceLocationAsync
▸ getDeviceLocationAsync(retorno de chamada: function
): void
Obtém o local do dispositivo armazenado anteriormente
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
retorno de chamada | function |
com parâmetros abaixo: * @param O local {string} pode ser nulo em caso de erro * @param {string} mensagem de erro em caso de erro, nulo caso contrário |
Retorna:void
getFontSizeMultiplierAsync
▸ getFontSizeMultiplierAsync(callback: function
): void
Obtém o multiplicador de tamanho da fonte para texto grande. Atual obrigatório apenas pelo iOS.
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
retorno de chamada | function |
com params abaixo * @param {string} multiplicador * @param {string} mensagem de erro em caso de erro, nulo caso contrário |
Retorna:void
getForwardContextAsync
▸ getForwardContextAsync(retorno de chamada: function
): void
Obtém detalhes do contexto de encaminhamento, como : a Criação de Cartão está no modo encaminhado
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
retorno de chamada | function |
com parâmetros abaixo: * @param {Json} retorna os Detalhes de Contexto na estrutura Json |
Retorna:void
getIsAppTimeFormat24HoursAsync
▸ getIsAppTimeFormat24HoursAsync(callback: function
): void
Obtém o formato atual de hora do aplicativo é de 24h ou não, o formato de hora selecionado pelo usuário, útil para formatar cadeias de caracteres de data e hora corretamente
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
retorno de chamada | function |
com parâmetros abaixo: * @param {string} isAppTimeFormat24Hours podem ser nulos em caso de erro * @param {string} mensagem de erro em caso de erro, nulo caso contrário |
Retorna:void
getLocalizedStringsAsync
▸ getLocalizedStringsAsync(retorno de chamada: function
): void
Obtém o dicionário de cadeias de caracteres localizadas com base na localidade atual do aplicativo. As cadeias de caracteres devem ser fornecidas dentro do pacote com nomes como: strings_en.json, strings_hi.json etc.
Uso de Exemplo
KASClient.App.getLocalizedStringsAsync(function (strings, error) {
if (error != null) {
return;
}
//use the localized strings array
});
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
retorno de chamada | function |
com parâmetros abaixo: * @param As cadeias de caracteres {JSON} podem ser nulas em caso de erro * @param {string} mensagem de erro em caso de erro, nulo caso contrário |
Retorna:void
getLocationAddressAsync
▸ getLocationAddressAsync(params: KASLocationAddressParams, callback: function
): void
Obter cadeia de caracteres de endereço para coordenadas especificadas
Uso de Exemplo
var params = new KASClient.KASLocationAddressParams();
params.latitude = <latitude value>;
params.longitude = <longitude value>;
KASClient.App.getLocationAddressAsync(params,
function (address, error) {
if (!error) {
// do something with address - a JSON returned by google structure can be found at https://developers.google.com/maps/documentation/geocoding/intro#GeocodingResponses
}
}
});
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
Params | KASLocationAddressParams | KASLocationAddressParams |
retorno de chamada | function |
retorno de chamada na busca de endereços com params abaixo * @param {JSON} localiza um json que contém longitude latitute e outras informações * @param {string} mensagem de erro em caso de erro, nulo caso contrário |
Retorna:void
getMapImageAsBase64Async
▸ getMapImageAsBase64Async(params: KASLocationStaticMapImageParams, callback: function
): void
Baixe a imagem base 64 do mapa para as coordenadas especificadas
Uso de Exemplo
KASClient.App.getMapImageAsBase64Async(params, function (attachmentString, error) {
if (!error) {
blobString = "data:image/jpeg;base64," + attachmentString;
//use blobString as base64 data
}
});
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
Params | KASLocationStaticMapImageParams | KASLocationStaticMapImageParams |
retorno de chamada | function |
na conclusão do download com params abaixo * @param {string} anexoString base64 valor do anexo * @param {string} mensagem de erro em caso de erro, nulo caso contrário |
Retorna:void
getO365UserDetailsAsync
▸ getO365UserDetailsAsync(callback: function
): void
Obtém detalhes do usuário O365 conectado atual
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
retorno de chamada | function |
com parâmetros abaixo: * @param {Json} retorna o UserDetails na estrutura Json |
Retorna:void
getPackageCustomSettingsAsync
▸ getPackageCustomSettingsAsync(callback: function
): void
Obtém todas as configurações de personalização de um pacote (usado no caso de pacotes Type-4 e sua base).
Uso de Exemplo
KASClient.App.getPackageCustomSettingsAsync(function (settings, error) {
if (error != null) {
return;
}
//settings contains the settings json defined at the package level
});
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
retorno de chamada | function |
com parâmetros abaixo: * @param As configurações do {JSON} podem ser nulas em caso de erro * @param {string} mensagem de erro em caso de erro, nulo caso contrário |
Retorna:void
getUsersDetailsAsync
▸ getUsersDetailsAsync(userIds: string
[], retorno de chamada: function
): void
Obtém os detalhes dos usuários (nome, foto, número de telefone etc.) em suas IDs
Uso de Exemplo
var userIds = ["<uid1>", "<uid2>",...];
KASClient.App.getUsersDetailsAsync(userIds, function (users, error) {
if (error != null) {
return;
}
var userInfo1 = users[<uid1>];
var userInfo2 = users[<uid2>];
...
});
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
userIds | string [] |
matriz de IDs de usuário |
retorno de chamada | function |
com parâmetros abaixo: * @param {Dictionary< UserId: string, UserInfo: KASUser>} userIdToInfoMap (detalhes dos usuários em relação às suas IDs) pode ser nulo em caso de erro * @param {string} mensagem de erro em caso de erro, nulo caso contrário |
Retorna:void
hideProgressBar
▸ hideProgressBar(): void
Oculta a barra de progresso atual, se houver
Retorna:void
isAttachmentDownloadingAsync
▸ isAttachmentDownloadingAsync(anexo: KASAttachment, callback: function
): void
Baixar o anexo especificado
Uso de Exemplo
var attachmentJson = {
ty: 3,
afn: "131490_Desert (1) (4).pdf",
lpu: "",
spu: '<server path>',
asb: 846941,
id:''
};
var attachment = KASClient.KASAttachment.fromJSON(attachmentJson);
KASClient.App.isAttachmentDownloadingAsync(attachment, function(isAttachmentDownloadingOrDownLoaded, error){
if (!error) {
console.log(isAttachmentDownloadingOrDownLoaded); //boolean
}
});
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
anexo | KASAttachment | anexo com um caminho de servidor válido para baixar |
retorno de chamada | function |
retorno de chamada na conclusão do download com params abaixo * @param {boolean} isAttachmentDownloadingOrDownLoaded sinalizador representando se o anexo estiver baixando/baixado * @param {string} mensagem de erro em caso de erro, nulo caso contrário |
Retorna:void
isAuthenticationTyepSupportedAsync
▸ isAuthenticationTyepSupportedAsync(authenticationType?: KASAuthenticationType, callback: function
): void
Verifica se a autenticação do tipo é possível ou não.
Parâmetros:
Nome | Tipo | Valor padrão | Descrição |
---|---|---|---|
Default value Authenticationtype |
KASAuthenticationType | KASAuthenticationType.None | tipo de autenticação. |
retorno de chamada | function |
- | com parâmetros abaixo: * @param {boolean} isSuccessful true se a impressão de dedo for possível * @param {string} reasonCode código de razão por que a impressão digital não é possível |
Retorna:void
isTalkBackEnabledAsync
▸ isTalkBackEnabledAsync(retorno de chamada: function
): void
Obtém se o talkback está habilitado ou não
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
retorno de chamada | function |
com parâmetros abaixo: * @param {boolean} talkBackEnabled true se o talkback estiver habilitado |
Retorna:void
logToReport
▸ logToReport(data: string
): void
Logs de dados para "Enviar relatório"
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
data | string |
string |
Retorna:void
openAttachmentImmersiveView
▸ openAttachmentImmersiveView(attachmentObj: KASAttachment): void
Abra o anexo no modo de exibição Imersivo.
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
attachmentObj | KASAttachment |
Retorna:void
openImmersiveViewForAttachmentList
▸ openImmersiveViewForAttachmentList(attachmentList: KASAttachment[], atIndex?: number
): void
Abra o anexo no modo de exibição Imersivo.
Parâmetros:
Nome | Tipo | Valor padrão |
---|---|---|
attachmentList | KASAttachment[] | - |
Default value atIndex |
number |
0 |
Retorna:void
performAuthenticationAsync
▸ performAuthenticationAsync(authenticationType?: KASAuthenticationType, callback: function
): void
Se o tipo de autenticação for permitido, essa API executará a autenticação e retornará o status de êxito/false, caso contrário, ela retornará uma cadeia de erros com o motivo pelo qual a autenticação não é possível.
Uso de Exemplo
KASClient.App.performAuthenticationAsync(KASAuthenticationType.Password, function (isSuccessful, reasonCode) {
if (!isSuccessful) {
console.log(resonCode);
}
});
Parâmetros:
Nome | Tipo | Valor padrão | Descrição |
---|---|---|---|
Default value Authenticationtype |
KASAuthenticationType | KASAuthenticationType.None | tipo de autenticação. |
retorno de chamada | function |
- | com parâmetros abaixo: * @param {boolean} isSuccessful true se o formulário ainda não tiver expirado * @param {string} reasonCode código de razão em caso de erro, nulo caso contrário |
Retorna:void
executarHTTPRequest
▸ executeHTTPRequest(url: string
, parametersJSON: string
, retorno de chamada: function
): void
executa uma solicitação http e retorna a resposta conforme especificado abaixo:
Uso de Exemplo
var url = "<url>";
var parametersJson = JSON.stringify({ "method" : "GET" });
KASClient.App.performHTTPRequest(url, parametersJson, function (response, error) {
if (!error) {
//use the response
}
});
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
url | string |
url base a ser aberta |
parametersJSON | string |
Jsonstring contendo parâmetros pode ser dado como nulo. Se for dada como nula, será feita uma solicitação à url fornecida acima. Os parâmetros incluem cabeçalho de solicitação, parâmetros de consulta(padrão em branco), método de solicitação (GET padrão) e corpo da solicitação (o corpo a ser postado se o método de solicitação for POST. default blank.) As chaves para parâmetros são: a.) "method" : método request. exemplo: "POST". padrão para "GET". b.) "requestBody": corpo da solicitação no caso de "POST". padrões para em branco. c.) "requestHeaders": cabeçalhos a serem enviados com solicitação. deve ser um json com chave como cabeçalho de solicitação e valor como o valor desejado. padrões para em branco. d.) "queryParameters": parâmetros de consulta. será codificado na url. deve ser um json com chave como nome e valor de parâmetro como seu valor. padrões para em branco. e.) "requestResourcePath": será acrescentado à url base. o padrão está em branco. |
retorno de chamada | function |
retorno de chamada com parâmetros abaixo: * @param Corpo da resposta {string} retornado Isso pode ter duas configurações possíveis: Se a solicitação foi um sucesso, ela retornará jsonstring com as seguintes chaves: a.) "HttpResponseCode": o código de resposta da solicitação. b.) "HttpResponseHeader": Os cabeçalhos HTTP de resposta c.) "HttpResponseBody": o corpo da resposta retornado para solicitação. Se houve um erro de rede, ele retornará: a.) "HttpErrorCode": o código de erro b.) "HttpErrorMessage": a mensagem de erro, por exemplo. URL malformada, Não é possível se conectar ao host etc. * @param Erro {string} se houver : isso inclui o código de erro padrão definido na documentação KASClient. |
Retorna:void
Printf
▸ printf(main: string
, ... args: any
[]): string
Retorna uma cadeia de caracteres.
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
Principal | string |
|
Rest Args |
any [] |
matriz de argumentos. |
Retorna:string
readDataFromTmpDirAsync
▸ readDataFromTmpDirAsync(filePath: string
, retorno de chamada: function
): void
Lê o conteúdo do arquivo como base64 do armazenamento de cache temporário. Usado em conjunto com a API saveDataInAppCacheAsync para os arquivos armazenados usando essa API.
Uso de Exemplo
KASClient.App.readDataFromTmpDirAsync(filePath, function (base64Data, error) {
if (error == null) {
// Action's code in success case
}
});
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
Filepath | string |
filepath que deve ser lido |
retorno de chamada | function |
com parâmetros abaixo: |
Retorna:void
readTalkBackMessage
▸ readTalkBackMessage(talkBackMessage: string
): void
Lê o texto se o TalkBack/VoiceOver estiver habilitado
Parâmetros:
Nome | Tipo |
---|---|
talkBackMessage | string |
Retorna:void
registerHardwareBackPressCallback
▸ registerHardwareBackPressCallback(callback?: function
): void
Registra um retorno de chamada a ser executado no botão de backup do hardware (para Android)
Parâmetros:
Nome | Tipo | Valor padrão | Descrição |
---|---|---|---|
Default value Callback |
function |
null | método a ser executado |
Retorna:void
saveDataInTmpDirAsync
▸ saveDataInTmpDirAsync(base64Data: string
, fileName: string
, retorno de chamada: function
): void
Salva dados base64 no dispositivo com nome de arquivo fornecido. As ações podem usar essa API para armazenar dados temporariamente no armazenamento do dispositivo, que podem ser encaminhados em cargas de atualização de formulário/resposta/propriedades nessa sessão. Observe que esses dados são armazenados no diretório local de cache temporário e podem ser excluídos pelo sistema operacional do dispositivo sem aviso em cenários de armazenamento baixo. O tempo máximo de vida desse armazenamento está dentro de uma sessão da ação. Depois que a tela for descartada, esses dados serão desmarcados. Normalmente, a ação pode usar esse armazenamento para salvar dados de imagem/áudio base64 no armazenamento e encaminhar esse caminho no json da pesquisa/ resposta e o cliente garantirá que ele seja carregado no serviço no fluxo de envio de mensagens.
Uso de Exemplo
KASClient.App.saveDataInTmpDirAsync(base64Data, fileName, function (filePath, error) {
if (error == null) {
// Action's code in success case
}
});
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
base64Data | string |
dados base64 a serem armazenados. |
fileName | string |
fileName incluindo a extensão relevante que deve ser usada para armazenar os dados. O comprimento máximo do nome do arquivo permitido é de 15 e ele só pode conter caracteres alfanuméricos, sublinhados, hifen e pontos, ou seja, "a-zA-Z0-9_.-". Por exemplo, file1.mp3 |
retorno de chamada | function |
com parâmetros abaixo: |
Retorna:void
setNativeToolbarProperties
▸ setNativeToolbarProperties(propriedades: KASNativeToolbarProperties): void
Define poucas propriedades ao usar a barra de ferramentas nativa
Uso de Exemplo
var nativeToolbarProps = new KASClient.KASNativeToolbarProperties();
nativeToolbarProps.icon = "<image>"
nativeToolbarProps.title = "<title>";
nativeToolbarProps.subtitle = "<subtitle>";
KASClient.App.setNativeToolbarProperties(nativeToolbarProps);
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
properties | KASNativeToolbarProperties |
Retorna:void
setUserStrings
▸ setUserStrings(strings?: JSON
): void
Parâmetros:
Nome | Tipo | Valor padrão |
---|---|---|
Default value Strings |
JSON |
null |
Retorna:void
showAttachmentPickerAsync
▸ showAttachmentPickerAsync(supportedTypes: KASAttachmentType[], props: JSON
, retorno de chamada: function
): void
Exibe um seletor de anexo na camada nativa
Uso de Exemplo
var attachmentsTypesToShow = [];
attachmentsTypesToShow.push(KASClient.KASAttachmentType.Image);
attachmentsTypesToShow.push(KASClient.KASAttachmentType.Document);
attachmentsTypesToShow.push(KASClient.KASAttachmentType.Audio);
KASClient.App.showAttachmentPickerAsync(attachmentsTypesToShow, null, function (selectedAttachments, error) {
if (error != null) {
return;
}
if (selectedAttachments && selectedAttachments.length > 0) {
for (var i = 0; i < selectedAttachments.length; i++) {
if (selectedAttachments[i].type == KASClient.KASAttachmentType.Image) {
this.imageAttachmentList.push(selectedAttachments[i]);
}
...
}...
}
});
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
Supportedtypes | KASAttachmentType[] | matriz de tipos de anexo com suporte para o seletor. |
Adereços | JSON |
adereços adicionais para configurar o seletor |
retorno de chamada | function |
com parâmetros abaixo * @param {KASAttachment[]} cadeia de caracteresattachments selecionada de anexos selecionados * @param {string} mensagem de erro em caso de erro, nulo caso contrário |
Retorna:void
showBarcodeScannerAsync
▸ showBarcodeScannerAsync(retorno de chamada: function
): void
Inicia o scanner de código de barras e retorna o objeto digitalizado
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
retorno de chamada | function |
com parâmetros abaixo: * @param {string} código de barrasInfo pode ser nulo em caso de erro * @param {string} mensagem de erro em caso de erro, nulo caso contrário |
Retorna:void
showContactPickerAsync
▸ showContactPickerAsync(title: string
, selectedMutableUser: string
[], selectedImmutableUser: string
[], isSingleSelection: boolean
, callback: function
): void
Mostra um seletor de contato nativo e retorna uma matriz de todos os detalhes dos usuários selecionados
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
title | string |
do Seletor de Contatos |
selectedMutableUser | string [] |
matriz de userIds selecionados |
selectedImmutableUser | string [] |
matriz de userIds selecionados fixos |
isSingleSelection | boolean |
seleção única no Seletor de Contatos |
retorno de chamada | function |
com parâmetros abaixo: * @param {KASUser[]} selecionadosUsers (matriz de detalhes do usuário) podem ser nulos em caso de erro * @param {string} mensagem de erro em caso de erro, nulo caso contrário |
Retorna:void
Matriz de todos os detalhes dos usuários selecionados (Matriz de JSON)
Uso de Exemplo
var alreadySelectedUserIds = [];
KASClient.App.showContactPickerAsync("<picker title>", alreadySelectedUserIds, [], true, function (selectedUsers, error) {
if (error == null && selectedUsers != null && selectedUsers.length > 0) {
var selectedUser = selectedUsers[0]; //KASUser
console.log(selectedUser.id);
}
});
showDurationPickerAsync
▸ showDurationPickerAsync(defaultDurationInMinutes: number
, retorno de chamada: function
): void
Mostra um seletor de duração nativo com dia/hora/minuto
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
defaultDurationInMinutes | number |
a duração padrão a ser mostrada no seletor |
retorno de chamada | function |
com parâmetros abaixo: * @param Duração {number}InMinutes selecionada duração em minutos * @param {string} mensagem de erro em caso de erro, nulo caso contrário |
Retorna:void
showImageImmersiveView
▸ showImageImmersiveView(urls?: string
[], currentImageIndex?: number
): void
Mostra imagem em exibição imersiva.
Uso de Exemplo
var urlArray = ["path1", "path2"];
KASClient.App.showImageImmersiveView(urlArray);
Parâmetros:
Nome | Tipo | Valor padrão | Descrição |
---|---|---|---|
Default value Urls |
string [] |
[] | Matriz de imagens url: |
Default value currentImageIndex |
number |
0 |
Retorna:void
showImagePickerAsync
▸ showImagePickerAsync(retorno de chamada: function
): void
Mostra um seletor de imagem nativo e retorna o caminho de imagem selecionado
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
retorno de chamada | function |
com parâmetros abaixo: * @param {string} selecionadoImagePath pode ser nulo em caso de erro * @param {string} mensagem de erro em caso de erro, nulo caso contrário |
Retorna:void
Local da imagem selecionado
showLocationOnMap
▸ showLocationOnMap(local: KASLocation): void
mostra um local específico, conforme mencionado em KASLocation
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
localização | KASLocation |
Retorna:void
showNativeErrorMessage
▸ showNativeErrorMessage(message: string
): void
Mostra um alerta nativo (para iOS) ou um brinde (para Android) com a mensagem
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
mensagem | string |
Retorna:void
showPlacePickerAsync
▸ showPlacePickerAsync(retorno de chamada: function
): void
Mostra um seletor de local nativo e retorna o local selecionado (lt, lg, n)
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
retorno de chamada | function |
com parâmetros abaixo: * @param {KASLocation} selecionadoLocation pode ser nulo em caso de erro * @param {string} mensagem de erro em caso de erro, nulo caso contrário |
Retorna:void
showProgressBar
▸ showProgressBar(texto: string
): void
Mostra uma barra de progresso sreen completa nativa com o texto fornecido
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
texto | string |
Retorna:void
showQRcodeScannerAsync
▸ showQRcodeScannerAsync(callback: function
): void
Inicia o scanner de código QR e retorna o objeto digitalizado
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
retorno de chamada | function |
com parâmetros abaixo: * @param {string} qrCodeInfo pode ser nulo em caso de erro * @param {string} mensagem de erro em caso de erro, nulo caso contrário |
Retorna:void
showUserProfileAsync
▸ showUserProfileAsync(userId: string
, isMiniProfile: boolean
, retorno de chamada: function
): void
Mostra a página/detalhes do perfil de um usuário
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
userId | string |
do usuário cujo perfil deve ser mostrado |
isMiniProfile | boolean |
se deve mostrar o mini-perfil primeiro |
retorno de chamada | function |
com parâmetros abaixo: * @param {boolean} sucesso verdadeiro se bem sucedido, false caso contrário * @param {string} mensagem de erro em caso de erro, nulo caso contrário |
Retorna:void
startChatAsync
▸ startChatAsync(userId: string
, retorno de chamada: function
): void
Inicia o chat com um usuário
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
userId | string |
do usuário |
retorno de chamada | function |
com parâmetros abaixo: * @param {boolean} sucesso * @param Erro {string} |
Retorna:void
updateActionLocalCacheAsync
▸ updateActionLocalCacheAsync(actionLocalCacheProps: KASActionLocalCacheProp, callback: function
): void
Atualizações/salva o valor fornecido em relação à chave para o cache de dados local
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
actionLocalCacheProps | KASActionLocalCacheProp | propriedade de dados a serem salvos em cache |
retorno de chamada | function |
retorno de chamada com parâmetros abaixo: ** @param o sucesso {boolean} indica se a atualização é bem-sucedida ou não ** @param {string} cadeia de caracteres de erro para o objeto KASError que contém código de erro e/ou descrição. |
Retorna:void
updateTenantUserProfileAsync
▸ updateTenantUserProfileAsync(attributeDataList: TenantAttributeData[], retorno de chamada: function
): void
Atualizações os atributos de locatário do usuário atual. O locatário da conversa no contexto será usado para isso.
Observação
A Ação deve pertencer ao mesmo locatário da conversa e o usuário precisa ser conectado a esse locatário para que essa api funcione
Uso de Exemplo
var tenantAttributeDataList = [
new KASClient.TenantAttributeData("attribute_id_1", "AttributeValue1"),
new KASClient.TenantAttributeData("attribute_id_2", "AttributeValue2")
];
KASClient.App.updateTenantUserProfileAsync(tenantAttributeDataList, function(success, error) {
if (error == null && success) {
console.log("SUCCESS");
}
});
Parâmetros:
Nome | Tipo | Descrição |
---|---|---|
attributeDataList | TenantAttributeData[] | pares de id-value de atributo locatário |
retorno de chamada | function |
com parâmetros abaixo: * @param {boolean} sucesso verdadeiro se bem sucedido, false caso contrário * @param {string} mensagem de erro em caso de erro, nulo caso contrário |
Retorna:void
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de