Módulo: Aplicación
Índice
Funciones
- 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
- performHTTPRequest
- Printf
- readDataFromTmpDirAsync
- readTalkBackMessage
- registerHardwareBackPressCallback
- saveDataInTmpDirAsync
- setNativeToolbarProperties
- setUserStrings
- showAttachmentPickerAsync
- showBarcodeScannerAsync
- showContactPickerAsync
- showDurationPickerAsync
- showImageImmersiveView
- showImagePickerAsync
- showLocationOnMap
- showNativeErrorMessage
- showPlacePickerAsync
- showProgressBar
- showQRcodeScannerAsync
- showUserProfileAsync
- startChatAsync
- updateActionLocalCacheAsync
- updateTenantUserProfileAsync
Funciones
cancelAttachmentDownloadAsync
▸ cancelAttachmentDownloadAsync(attachment: KASAttachment, callback: function
): void
Cancelación de una operación de descarga en cola para datos adjuntos
Uso de ejemplo
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:
Nombre | Tipo | Descripción |
---|---|---|
datos adjuntos | KASAttachment | - |
callback | function |
con parámetro de error: cadena de error en caso de error; null en caso contrario |
Devuelve:void
deleteActionLocalCacheAsync
▸ deleteActionLocalCacheAsync(actionLocalCacheProps: KASActionLocalCacheProp, callback: function
): void
Eliminación de la clave especificada de la caché de datos local
Parámetros:
Nombre | Tipo | Descripción |
---|---|---|
actionLocalCacheProps | KASActionLocalCacheProp | propiedad de los datos que se van a eliminar de la memoria caché |
callback | function |
devolución de llamada con los parámetros siguientes: ** @param {boolean} success indica si la actualización es correcta o no ** @param {string} error json string para el objeto KASError que contiene código de error o descripción. |
Devuelve:void
deleteDataFromTmpDirAsync
▸ deleteDataFromTmpDirAsync(filePath: string
, callback: function
): void
Elimina el archivo del almacenamiento de caché temporal. Se usa junto con la API saveDataInTmpDirAsync para los archivos almacenados mediante esta API.
Uso de ejemplo
KASClient.App.deleteDataFromTmpDirAsync(filePath, function (success, error) {
if (error == null && success) {
// Action's code in success case
}
});
Parámetros:
Nombre | Tipo | Descripción |
---|---|---|
Filepath | string |
filepath que se debe leer |
callback | function |
con los parámetros siguientes: |
Devuelve:void
dismissCurrentScreen
▸ dismissCurrentScreen(): void
Descartar la pantalla de la acción abierta actual (creación, respuesta o resumen)
Devuelve:void
downloadAttachmentAsync
▸ downloadAttachmentAsync(attachment: KASAttachment, callback: function
): void
Descargar los datos adjuntos especificados
Uso de ejemplo
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:
Nombre | Tipo | Descripción |
---|---|---|
datos adjuntos | KASAttachment | datos adjuntos con una ruta de acceso de servidor válida para descargar |
callback | function |
devolución de llamada al finalizar la descarga con los parámetros siguientes * @param {KASAttachment} descargóAttachment los datos adjuntos que se descargaron * @param {string} mensaje de error en caso de error, null en caso contrario |
Devuelve:void
fetchTenantUserAttributeDetailsAsync
▸ fetchTenantUserAttributeDetailsAsync(callback: function
): void
Captura los detalles del atributo de inquilino. El inquilino de la conversación en contexto se usará para esto.
Nota:
La acción debe pertenecer al mismo inquilino de la conversación y el usuario debe iniciar sesión en ese inquilino para que esta API funcione.
Uso de ejemplo
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:
Nombre | Tipo | Descripción |
---|---|---|
callback | function |
con los parámetros siguientes: * @param Matriz tenantAttribute[]} tenantAttributes de atributos de inquilino * @param {string} mensaje de error en caso de error, null en caso contrario |
Devuelve:void
fetchTenantUserProfilesAsync
▸ fetchTenantUserProfilesAsync(userIds: string
[], callback: function
): void
Captura los atributos de inquilino de los usuarios especificados. El inquilino de la conversación en contexto se usará para esto.
Nota:
La acción debe pertenecer al mismo inquilino de la conversación y el usuario debe iniciar sesión en ese inquilino para que esta API funcione.
Uso de ejemplo
// 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:
Nombre | Tipo | Descripción |
---|---|---|
userIds | string [] |
matriz de identificadores de usuario; si es null o está vacío, se capturará el perfil de inquilino del usuario actual. |
callback | function |
con los parámetros siguientes: * @param Matriz tenantUserProfile[]} tenantUserProfiles de los perfiles de inquilino de los usuarios (pares id-value de atributo) * @param {string} mensaje de error en caso de error, null en caso contrario |
Devuelve:void
generateBase64ThumbnailAsync
▸ generateBase64ThumbnailAsync(localPath: string
, callback: function
): void
Genera una miniatura de Base64 para una imagen cuya propiedad localPath se proporciona
Uso de ejemplo
KASClient.App.generateBase64ThumbnailAsync(localPath, function (thumbnail, error) {
if (error == null && thumbnail != null) {
//use the thumbnail data and update required dom
}
});
Parámetros:
Nombre | Tipo | Descripción |
---|---|---|
localPath | string |
localPath para imageAttachment cuya miniatura debe generarse |
callback | function |
con los parámetros siguientes: * @param {string} miniatura del valor base64 * @param {string} mensaje de error en caso de error, null en caso contrario |
Devuelve:void
generateUUIDAsync
▸ generateUUIDAsync(callback: function
): void
Obtiene el nuevo UUID.
Uso de ejemplo
KASClient.App.generateUUIDAsync(function (uuid, error) {
console.log("generatedUUIDAsync", uuid);
...
});
Parámetros:
Nombre | Tipo | Descripción |
---|---|---|
callback | function |
con los parámetros siguientes: * @param {string} uuid recién generado uuid * @param {string} mensaje de error en caso de error, null en caso contrario |
Devuelve:void
getActionLocalCacheAsync
▸ getActionLocalCacheAsync(actionLocalCacheProps: KASActionLocalCacheProp, callback: function
): void
Recupera la clave especificada para que el valor de la caché de datos local se guarde en el nivel mencionado en KASActionLocalCacheProp en consecuencia.
Parámetros:
Nombre | Tipo | Descripción |
---|---|---|
actionLocalCacheProps | KASActionLocalCacheProp | propiedad de los datos que se van a recuperar de la memoria caché |
callback | function |
devolución de llamada con los parámetros siguientes: ** { @param KASActionLocalCacheProp} actionLocalCacheProps indica si la actualización es correcta o no ** @param {cadena} de error json para el objeto KASError que contiene código de error o descripción. |
Devuelve:void
getAppLocaleAsync
▸ getAppLocaleAsync(callback: function
): void
Obtiene la configuración regional de la aplicación actual, el idioma en el que se representa la aplicación, útil para localizar las cadenas de MiniApp.
Parámetros:
Nombre | Tipo | Descripción |
---|---|---|
callback | function |
con los parámetros siguientes: * @param La configuración regional de {string} puede ser null en caso de error * @param {string} mensaje de error en caso de error, null en caso contrario |
Devuelve:void
getCalendarNameAsync
▸ getCalendarNameAsync(callback: function
): void
Obtiene la configuración actual del calendario del sistema. Esto es principalmente para iOS para identificar el nombre del calendario establecido en la configuración del teléfono como gregoriano o japonés o budistas.
Parámetros:
Nombre | Tipo | Descripción |
---|---|---|
callback | function |
con los parámetros siguientes: * @param {string} calendarName puede ser null en caso de error * @param {string} mensaje de error en caso de error, null en caso contrario |
Devuelve:void
getConversationDetailsAsync
▸ getConversationDetailsAsync(callback: function
): void
Obtiene las propiedades relacionadas con la conversación
Parámetros:
Nombre | Tipo | Descripción |
---|---|---|
callback | function |
con los parámetros siguientes: * @param {KASConversationDetails} propiedades de conversación de resultados * @param Cadena json de error {string} para el objeto KASError que contiene código de error o descripción. |
Devuelve:void
getCurrentDeviceLocationAsync
▸ getCurrentDeviceLocationAsync(callback: function
, canUseCachedLocation?: boolean
): void
Obtiene la ubicación actual del dispositivo.
Uso de ejemplo
KASClient.App.getCurrentDeviceLocationAsync(function (location, error){
if(error != null) {
return;
}
//use location(KASLocation) as the device location
}, false);
Parámetros:
Nombre | Tipo | Valor predeterminado | Descripción |
---|---|---|---|
callback | function |
- | con los parámetros siguientes: * @param La ubicación de {string} puede ser null en caso de error * @param {string} mensaje de error en caso de error, null en caso contrario |
Default value canUseCachedLocation |
boolean |
false | (opcional, el valor predeterminado es false) si esta marca es true, la plataforma puede optar por devolver una ubicación almacenada en caché de hasta 30 minutos de antigüedad en caso de que se produzca un error al capturar la ubicación actual. |
Devuelve:void
getCurrentLocale
▸ getCurrentLocale(): string
Devuelve:string
getDeviceIdAsync
▸ getDeviceIdAsync(callback: function
): void
Obtiene deviceId
Parámetros:
Nombre | Tipo | Descripción |
---|---|---|
callback | function |
con los parámetros siguientes: * @param {string} deviceId obtenido del servicio de enteros * @param {string} mensaje de error en caso de error, null en caso contrario |
Devuelve:void
getDeviceLocationAsync
▸ getDeviceLocationAsync(callback: function
): void
Obtiene la ubicación del dispositivo almacenada anteriormente
Parámetros:
Nombre | Tipo | Descripción |
---|---|---|
callback | function |
con los parámetros siguientes: * @param La ubicación de {string} puede ser null en caso de error * @param {string} mensaje de error en caso de error, null en caso contrario |
Devuelve:void
getFontSizeMultiplierAsync
▸ getFontSizeMultiplierAsync(callback: function
): void
Obtiene el multiplicador de tamaño de fuente para texto grande. Solo es necesario para iOS.
Parámetros:
Nombre | Tipo | Descripción |
---|---|---|
callback | function |
con los parámetros siguientes * @param Multiplicador {string} * @param {string} mensaje de error en caso de error, null en caso contrario |
Devuelve:void
getForwardContextAsync
▸ getForwardContextAsync(callback: function
): void
Obtiene los detalles del contexto de reenvío, como : La creación de tarjetas está en modo reenviado.
Parámetros:
Nombre | Tipo | Descripción |
---|---|---|
callback | function |
con los parámetros siguientes: * @param {Json} devuelve los detalles del contexto en la estructura Json |
Devuelve:void
getIsAppTimeFormat24HoursAsync
▸ getIsAppTimeFormat24HoursAsync(callback: function
): void
Obtiene el formato de hora de la aplicación actual es de 24 horas o no, el formato de hora seleccionado por el usuario, útil para dar formato correctamente a las cadenas de fecha y hora.
Parámetros:
Nombre | Tipo | Descripción |
---|---|---|
callback | function |
con los parámetros siguientes: * @param {string} isAppTimeFormat24Hours puede ser null en caso de error * @param {string} mensaje de error en caso de error, null en caso contrario |
Devuelve:void
getLocalizedStringsAsync
▸ getLocalizedStringsAsync(callback: function
): void
Obtiene el diccionario de cadenas localizadas en función de la configuración regional de la aplicación actual. Las cadenas deben proporcionarse dentro del paquete con nombres como: strings_en.json, strings_hi.json, etc.
Uso de ejemplo
KASClient.App.getLocalizedStringsAsync(function (strings, error) {
if (error != null) {
return;
}
//use the localized strings array
});
Parámetros:
Nombre | Tipo | Descripción |
---|---|---|
callback | function |
con los parámetros siguientes: * @param Las cadenas {JSON} pueden ser null en caso de error * @param {string} mensaje de error en caso de error, null en caso contrario |
Devuelve:void
getLocationAddressAsync
▸ getLocationAddressAsync(params: KASLocationAddressParams, callback: function
): void
Obtención de la cadena de dirección para las coordenadas especificadas
Uso de ejemplo
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:
Nombre | Tipo | Descripción |
---|---|---|
Params | KASLocationAddressParams | KASLocationAddressParams |
callback | function |
devolución de llamada en la captura de direcciones con los parámetros siguientes * @param {JSON} ubicación de un json que contiene longitud de latitute y otra información * @param {string} mensaje de error en caso de error, null en caso contrario |
Devuelve:void
getMapImageAsBase64Async
▸ getMapImageAsBase64Async(params: KASLocationStaticMapImageParams, callback: function
): void
Descargar la imagen base 64 del mapa para las coordenadas especificadas
Uso de ejemplo
KASClient.App.getMapImageAsBase64Async(params, function (attachmentString, error) {
if (!error) {
blobString = "data:image/jpeg;base64," + attachmentString;
//use blobString as base64 data
}
});
Parámetros:
Nombre | Tipo | Descripción |
---|---|---|
Params | KASLocationStaticMapImageParams | KASLocationStaticMapImageParams |
callback | function |
al finalizar la descarga con los parámetros siguientes * @param {string} attachmentString valor base64 de los datos adjuntos * @param {string} mensaje de error en caso de error, null en caso contrario |
Devuelve:void
getO365UserDetailsAsync
▸ getO365UserDetailsAsync(callback: function
): void
Obtiene los detalles del usuario actual que inició sesión en O365.
Parámetros:
Nombre | Tipo | Descripción |
---|---|---|
callback | function |
con los parámetros siguientes: * @param {Json} devuelve la estructura UserDetails en Json |
Devuelve:void
getPackageCustomSettingsAsync
▸ getPackageCustomSettingsAsync(callback: function
): void
Obtiene toda la configuración de personalización de un paquete (se usa en el caso de los paquetes type-4 y su base).
Uso de ejemplo
KASClient.App.getPackageCustomSettingsAsync(function (settings, error) {
if (error != null) {
return;
}
//settings contains the settings json defined at the package level
});
Parámetros:
Nombre | Tipo | Descripción |
---|---|---|
callback | function |
con los parámetros siguientes: * @param {JSON} la configuración puede ser nula en caso de error * @param {string} mensaje de error en caso de error, null en caso contrario |
Devuelve:void
getUsersDetailsAsync
▸ getUsersDetailsAsync(userIds: string
[], devolución de llamada: function
): void
Obtiene los detalles de los usuarios (nombre, imagen, número de teléfono, etc.) con sus identificadores.
Uso de ejemplo
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:
Nombre | Tipo | Descripción |
---|---|---|
userIds | string [] |
matriz de identificadores de usuario |
callback | function |
con los parámetros siguientes: * @param {Diccionario< UserId: string, UserInfo: KASUser>} userIdToInfoMap (los detalles de los usuarios con sus identificadores) pueden ser null en caso de error * @param {string} mensaje de error en caso de error, null en caso contrario |
Devuelve:void
hideProgressBar
▸ hideProgressBar(): void
Oculta la barra de progreso actual, si existe
Devuelve:void
isAttachmentDownloadingAsync
▸ isAttachmentDownloadingAsync(attachment: KASAttachment, callback: function
): void
Descargar los datos adjuntos especificados
Uso de ejemplo
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:
Nombre | Tipo | Descripción |
---|---|---|
datos adjuntos | KASAttachment | datos adjuntos con una ruta de acceso de servidor válida para descargar |
callback | function |
devolución de llamada al finalizar la descarga con los parámetros siguientes * @param {boolean} isAttachmentDownloadingOrDownLoaded marca que representa si los datos adjuntos se descargan o descargan * @param {string} mensaje de error en caso de error, null en caso contrario |
Devuelve:void
isAuthenticationTyepSupportedAsync
▸ isAuthenticationTyepSupportedAsync(authenticationType?: KASAuthenticationType, callback: function
): void
Comprueba si la autenticación de tipo es posible o no.
Parámetros:
Nombre | Tipo | Valor predeterminado | Descripción |
---|---|---|---|
Default value authenticationType |
KASAuthenticationType | KASAuthenticationType.None | tipo de autenticación. |
callback | function |
- | con los parámetros siguientes: * @param {boolean} isSuccessful true si es posible imprimir con el dedo * @param {string} reasonCode código de motivo por el que no es posible imprimir con el dedo |
Devuelve:void
isTalkBackEnabledAsync
▸ isTalkBackEnabledAsync(callback: function
): void
Obtiene si la devolución de llamada está habilitada o no
Parámetros:
Nombre | Tipo | Descripción |
---|---|---|
callback | function |
con los parámetros siguientes: * @param {boolean} talkBackEnabled true si talkback está habilitado |
Devuelve:void
logToReport
▸ logToReport(data: string
): void
Registros de datos para "Enviar informe"
Parámetros:
Nombre | Tipo | Descripción |
---|---|---|
data | string |
string |
Devuelve:void
openAttachmentImmersiveView
▸ openAttachmentImmersiveView(attachmentObj: KASAttachment): void
Abra los datos adjuntos en la vista Inmersiva.
Parámetros:
Nombre | Tipo | Descripción |
---|---|---|
attachmentObj | KASAttachment |
Devuelve:void
openImmersiveViewForAttachmentList
▸ openImmersiveViewForAttachmentList(attachmentList: KASAttachment[], atIndex?: number
): void
Abra los datos adjuntos en la vista Inmersiva.
Parámetros:
Nombre | Tipo | Valor predeterminado |
---|---|---|
attachmentList | KASAttachment[] | - |
Default value atIndex |
number |
0 |
Devuelve:void
performAuthenticationAsync
▸ performAuthenticationAsync(authenticationType?: KASAuthenticationType, callback: function
): void
Si se permite el tipo de autenticación, esta API realiza la autenticación y devuelve el estado correcto o falso; de lo contrario, devuelve una cadena de error con el motivo por el que no es posible la autenticación.
Uso de ejemplo
KASClient.App.performAuthenticationAsync(KASAuthenticationType.Password, function (isSuccessful, reasonCode) {
if (!isSuccessful) {
console.log(resonCode);
}
});
Parámetros:
Nombre | Tipo | Valor predeterminado | Descripción |
---|---|---|---|
Default value authenticationType |
KASAuthenticationType | KASAuthenticationType.None | tipo de autenticación. |
callback | function |
- | con los parámetros siguientes: * @param {boolean} isSuccessful true si el formulario aún no ha expirado * @param {string} reasonCode código de motivo en caso de error, null en caso contrario |
Devuelve:void
performHTTPRequest
▸ performHTTPRequest(url: string
, parametersJSON: string
, callback: function
): void
realiza una solicitud HTTP y devuelve la respuesta como se especifica a continuación:
Uso de ejemplo
var url = "<url>";
var parametersJson = JSON.stringify({ "method" : "GET" });
KASClient.App.performHTTPRequest(url, parametersJson, function (response, error) {
if (!error) {
//use the response
}
});
Parámetros:
Nombre | Tipo | Descripción |
---|---|---|
url | string |
dirección URL base que se va a abrir |
parametersJSON | string |
jsonstring que contiene parámetros se puede proporcionar como null. Si se proporciona como null, se realizará una solicitud a la dirección URL proporcionada anteriormente. Los parámetros incluyen encabezado de solicitud, parámetros de consulta (valor predeterminado en blanco), método de solicitud (get predeterminado) y cuerpo de la solicitud (el cuerpo que se va a publicar si el método de solicitud es POST. el valor predeterminado está en blanco). Las claves de los parámetros son: a.) "method" : método de solicitud. ejemplo: "POST". el valor predeterminado es "GET". b.) "requestBody": cuerpo de la solicitud en caso de "POST". el valor predeterminado es en blanco. c.) "requestHeaders": encabezados que se van a enviar con la solicitud. debe ser un json con clave como encabezado de solicitud y valor como valor deseado. el valor predeterminado es en blanco. d.) "queryParameters": parámetros de consulta. se codificará en la dirección URL. debe ser un json con clave como nombre de parámetro y valor como su valor. el valor predeterminado es en blanco. e.) "requestResourcePath": se anexará a la dirección URL base. el valor predeterminado está en blanco. |
callback | function |
devolución de llamada con los parámetros siguientes: * @param {string} response response body returned Esto podría tener dos configuraciones posibles: Si la solicitud se realizó correctamente, devuelve jsonstring con las claves siguientes: a.) "HttpResponseCode": el código de respuesta de la solicitud. b.) "HttpResponseHeader": encabezados HTTP de respuesta c.) "HttpResponseBody": el cuerpo de la respuesta devuelto para la solicitud. Si se produjo un error de red, devuelve lo siguiente: a.) "HttpErrorCode": el código de error b.) "HttpErrorMessage": el mensaje de error, por ejemplo. Dirección URL con formato incorrecto, No se puede conectar al host, etc. * @param {string} error si existe: incluye el código de error estándar definido en la documentación de KASClient. |
Devuelve:void
Printf
▸ printf(main: string
, ... args: any
[]): string
Devuelve una cadena.
Parámetros:
Nombre | Tipo | Descripción |
---|---|---|
Principal | string |
|
Rest Args |
any [] |
matriz de argumentos. |
Devuelve:string
readDataFromTmpDirAsync
▸ readDataFromTmpDirAsync(filePath: string
, callback: function
): void
Lee el contenido del archivo como base64 desde el almacenamiento en caché temporal. Se usa junto con api saveDataInAppCacheAsync para los archivos almacenados mediante esta API.
Uso de ejemplo
KASClient.App.readDataFromTmpDirAsync(filePath, function (base64Data, error) {
if (error == null) {
// Action's code in success case
}
});
Parámetros:
Nombre | Tipo | Descripción |
---|---|---|
Filepath | string |
filepath que se debe leer |
callback | function |
con los parámetros siguientes: |
Devuelve:void
readTalkBackMessage
▸ readTalkBackMessage(talkBackMessage: string
): void
Lee el texto si TalkBack/VoiceOver está habilitado
Parámetros:
Nombre | Tipo |
---|---|
talkBackMessage | string |
Devuelve:void
registerHardwareBackPressCallback
▸ registerHardwareBackPressCallback(callback?: function
): void
Registra una devolución de llamada que se va a ejecutar al presionar el botón atrás de hardware (para Android)
Parámetros:
Nombre | Tipo | Valor predeterminado | Descripción |
---|---|---|---|
Default value Callback |
function |
nulo | método que se va a ejecutar |
Devuelve:void
saveDataInTmpDirAsync
▸ saveDataInTmpDirAsync(base64Data: string
, fileName: string
, callback: function
): void
Guarda datos base64 en el dispositivo con un nombre de archivo determinado. Las acciones pueden usar esta API para almacenar datos temporalmente en el almacenamiento del dispositivo al que se puede hacer referencia en cargas de actualización de formularios, respuestas o propiedades en esa sesión. Tenga en cuenta que estos datos se almacenan en el directorio de caché temporal local y se pueden eliminar mediante el sistema operativo del dispositivo sin advertencia en escenarios de almacenamiento bajo. La duración máxima de este almacenamiento está dentro de una sesión de la acción. Una vez que se descarta la pantalla, estos datos se borran. Normalmente, la acción puede usar este almacenamiento para guardar datos de imagen o audio base64 en el almacenamiento y hacer referencia a esa ruta en json/respuesta de encuesta y el cliente se asegurará de que se cargue en el servicio en el flujo de envío de mensajes.
Uso de ejemplo
KASClient.App.saveDataInTmpDirAsync(base64Data, fileName, function (filePath, error) {
if (error == null) {
// Action's code in success case
}
});
Parámetros:
Nombre | Tipo | Descripción |
---|---|---|
base64Data | string |
datos base64 que se van a almacenar. |
fileName | string |
fileName, incluida la extensión pertinente, que se debe usar para almacenar los datos. La longitud máxima permitida del nombre de archivo es 15 y solo puede contener caracteres alfanuméricos, caracteres de subrayado, hifen y puntos, es decir, "a-zA-Z0-9_.-". Por ejemplo, file1.mp3 |
callback | function |
con los parámetros siguientes: |
Devuelve:void
setNativeToolbarProperties
▸ setNativeToolbarProperties(properties: KASNativeToolbarProperties): void
Establece algunas propiedades al usar la barra de herramientas nativa
Uso de ejemplo
var nativeToolbarProps = new KASClient.KASNativeToolbarProperties();
nativeToolbarProps.icon = "<image>"
nativeToolbarProps.title = "<title>";
nativeToolbarProps.subtitle = "<subtitle>";
KASClient.App.setNativeToolbarProperties(nativeToolbarProps);
Parámetros:
Nombre | Tipo | Descripción |
---|---|---|
properties | KASNativeToolbarProperties |
Devuelve:void
setUserStrings
▸ setUserStrings(strings?: JSON
): void
Parámetros:
Nombre | Tipo | Valor predeterminado |
---|---|---|
Default value Cadenas |
JSON |
nulo |
Devuelve:void
showAttachmentPickerAsync
▸ showAttachmentPickerAsync(supportedTypes: KASAttachmentType[], props: JSON
, callback: function
): void
Muestra un selector de datos adjuntos en la capa nativa
Uso de ejemplo
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:
Nombre | Tipo | Descripción |
---|---|---|
supportedTypes | KASAttachmentType[] | matriz de tipos de datos adjuntos admitidos para el selector. |
Apoyos | JSON |
propiedades adicionales para configurar el selector |
callback | function |
con los parámetros siguientes * @param {KASAttachment[]} selectedAttachments string of selected attachments * @param {string} mensaje de error en caso de error, null en caso contrario |
Devuelve:void
showBarcodeScannerAsync
▸ showBarcodeScannerAsync(callback: function
): void
Inicia el escáner de código de barras y devuelve el objeto escaneado.
Parámetros:
Nombre | Tipo | Descripción |
---|---|---|
callback | function |
con los parámetros siguientes: * @param {string} barcodeInfo puede ser null en caso de error * @param {string} mensaje de error en caso de error, null en caso contrario |
Devuelve:void
showContactPickerAsync
▸ showContactPickerAsync(title: string
, selectedMutableUser: string
[], selectedImmutableUser: string
[], isSingleSelection: boolean
, callback: function
): void
Muestra un selector de contactos nativo y devuelve una matriz de todos los detalles de los usuarios seleccionados.
Parámetros:
Nombre | Tipo | Description |
---|---|---|
title | string |
de Selector de contactos |
selectedMutableUser | string [] |
matriz de userIds seleccionados |
selectedImmutableUser | string [] |
matriz de userIds seleccionados fijos |
isSingleSelection | boolean |
selección única en selector de contactos |
callback | function |
con los parámetros siguientes: * @param {KASUser[]} selectedUsers (matriz de detalles del usuario) puede ser null en caso de error. * @param {string} mensaje de error en caso de error, null en caso contrario |
Devuelve:void
Matriz de todos los detalles de los usuarios seleccionados (matriz de JSON)
Uso de ejemplo
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
, callback: function
): void
Muestra un selector de duración nativo con día/hora/minuto
Parámetros:
Nombre | Tipo | Descripción |
---|---|---|
defaultDurationInMinutes | number |
la duración predeterminada que se mostrará en el selector |
callback | function |
con los parámetros siguientes: * @param {number} durationInMinutes selected duration in minutes * @param {string} mensaje de error en caso de error, null en caso contrario |
Devuelve:void
showImageImmersiveView
▸ showImageImmersiveView(urls?: string
[], currentImageIndex?: number
): void
Muestra la imagen en la vista inmersiva.
Uso de ejemplo
var urlArray = ["path1", "path2"];
KASClient.App.showImageImmersiveView(urlArray);
Parámetros:
Nombre | Tipo | Valor predeterminado | Descripción |
---|---|---|---|
Default value Url |
string [] |
[] | Matriz de direcciones URL de imágenes: |
Default value currentImageIndex |
number |
0 |
Devuelve:void
showImagePickerAsync
▸ showImagePickerAsync(callback: function
): void
Muestra un selector de imágenes nativo y devuelve la ruta de acceso de la imagen seleccionada.
Parámetros:
Nombre | Tipo | Descripción |
---|---|---|
callback | function |
con los parámetros siguientes: * @param {string} selectedImagePath puede ser null en caso de error * @param {string} mensaje de error en caso de error, null en caso contrario |
Devuelve:void
Ubicación de la imagen seleccionada
showLocationOnMap
▸ showLocationOnMap(location: KASLocation): void
muestra una ubicación determinada como se mencionó en KASLocation
Parámetros:
Nombre | Tipo | Descripción |
---|---|---|
ubicación | KASLocation |
Devuelve:void
showNativeErrorMessage
▸ showNativeErrorMessage(message: string
): void
Muestra una alerta nativa (para iOS) o una notificación del sistema (para Android) con el mensaje
Parámetros:
Nombre | Tipo | Descripción |
---|---|---|
mensaje | string |
Devuelve:void
showPlacePickerAsync
▸ showPlacePickerAsync(callback: function
): void
Muestra un selector de lugar nativo y devuelve el lugar seleccionado (lt, lg, n)
Parámetros:
Nombre | Tipo | Descripción |
---|---|---|
callback | function |
con los parámetros siguientes: * @param {KASLocation} selectedLocation puede ser null en caso de error * @param {string} mensaje de error en caso de error, null en caso contrario |
Devuelve:void
showProgressBar
▸ showProgressBar(text: string
): void
Muestra una barra de progreso completa nativa con el texto especificado
Parámetros:
Nombre | Tipo | Descripción |
---|---|---|
text | string |
Devuelve:void
showQRcodeScannerAsync
▸ showQRcodeScannerAsync(callback: function
): void
Inicia el escáner de código QR y devuelve el objeto examinado.
Parámetros:
Nombre | Tipo | Descripción |
---|---|---|
callback | function |
con los parámetros siguientes: * @param {string} qrCodeInfo puede ser null en caso de error * @param {string} mensaje de error en caso de error, null en caso contrario |
Devuelve:void
showUserProfileAsync
▸ showUserProfileAsync(userId: string
, isMiniProfile: boolean
, callback: function
): void
Muestra la página de perfil o los detalles de un usuario
Parámetros:
Nombre | Tipo | Description |
---|---|---|
userId | string |
del usuario cuyo perfil se va a mostrar |
isMiniProfile | boolean |
si se debe mostrar primero el mini-perfil |
callback | function |
con los parámetros siguientes: * @param {boolean} success true si es correcto, false en caso contrario * @param {string} mensaje de error en caso de error, null en caso contrario |
Devuelve:void
startChatAsync
▸ startChatAsync(userId: string
, devolución de llamada: function
): void
Inicia el chat con un usuario
Parámetros:
Nombre | Tipo | Description |
---|---|---|
userId | string |
del usuario |
callback | function |
con los parámetros siguientes: * @param {boolean} correcto * @param {string} error |
Devuelve:void
updateActionLocalCacheAsync
▸ updateActionLocalCacheAsync(actionLocalCacheProps: KASActionLocalCacheProp, callback: function
): void
Novedades o guarda el valor especificado en la clave en la caché de datos local
Parámetros:
Nombre | Tipo | Descripción |
---|---|---|
actionLocalCacheProps | KASActionLocalCacheProp | propiedad de los datos que se van a guardar en la memoria caché |
callback | function |
devolución de llamada con los parámetros siguientes: ** @param {boolean} success indica si la actualización es correcta o no ** @param {string} error json string para el objeto KASError que contiene código de error o descripción. |
Devuelve:void
updateTenantUserProfileAsync
▸ updateTenantUserProfileAsync(attributeDataList: TenantAttributeData[], callback: function
): void
Novedades los atributos de inquilino del usuario actual. El inquilino de la conversación en contexto se usará para esto.
Nota:
La acción debe pertenecer al mismo inquilino de la conversación y el usuario debe iniciar sesión en ese inquilino para que esta API funcione.
Uso de ejemplo
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:
Nombre | Tipo | Descripción |
---|---|---|
attributeDataList | TenantAttributeData[] | pares id-value del atributo de inquilino |
callback | function |
con los parámetros siguientes: * @param {boolean} success true si es correcto, false en caso contrario * @param {string} mensaje de error en caso de error, null en caso contrario |
Devuelve:void
Comentarios
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Enviar y ver comentarios de