From 624099ca4935b16e23062620549232bcb1440174 Mon Sep 17 00:00:00 2001 From: circleci Date: Fri, 6 Oct 2023 07:12:35 +0000 Subject: [PATCH] Publish documentation for 5.6.0 --- _versions/5.6.md | 3 + docs/5.6/api/index.md | 23 + .../-a-d-d/index.md | 15 + .../-c-h-a-n-g-e/index.md | 15 + .../-c-l-o-s-e/index.md | 15 + .../-d-e-l-e-t-e/index.md | 15 + .../-o-p-e-n/index.md | 15 + .../-m-a-analytics-action-type/index.md | 25 + .../-a-p-p-e-a-r/index.md | 15 + .../-c-l-i-c-k/index.md | 15 + .../-c-u-s-t-o-m/index.md | 15 + .../-e-r-r-o-r/index.md | 15 + .../-m-a-analytics-event-type/index.md | 24 + .../-m-a-analytics-info.md | 6 + .../-m-a-analytics-info/action-type.md | 6 + .../-m-a-analytics-info/component-name.md | 6 + .../-m-a-analytics-info/data.md | 6 + .../-m-a-analytics-info/element-type.md | 6 + .../-m-a-analytics-info/event-type.md | 6 + .../-m-a-analytics-info/index.md | 25 + .../-m-a-analytics-info/page-name.md | 6 + .../-mini-app-analytics-config.md | 6 + .../-mini-app-analytics-config/acc.md | 6 + .../-mini-app-analytics-config/aid.md | 6 + .../-mini-app-analytics-config/index.md | 28 + .../index.md | 12 + .../-mini-app-close-alert-info.md | 6 + .../-mini-app-close-alert-info/description.md | 6 + .../-mini-app-close-alert-info/index.md | 22 + .../should-display.md | 6 + .../-mini-app-close-alert-info/title.md | 6 + .../index.md | 9 + .../-mini-app-default-file-provider.md | 6 + .../-mini-app-default-file-provider/index.md | 59 + .../index.md | 9 + .../audience-not-supported-error.md | 6 + .../-companion/authorization-failure-error.md | 8 + .../-companion/custom.md | 8 + .../-companion/index.md | 20 + .../-companion/scopes-not-supported-error.md | 6 + .../-mini-app-access-token-error.md | 6 + .../-mini-app-access-token-error/index.md | 27 + .../-mini-app-access-token-error/message.md | 6 + .../-mini-app-access-token-error/type.md | 6 + .../-mini-app-bridge-error.md | 6 + .../-mini-app-bridge-error/index.md | 23 + .../-companion/download-failed-error.md | 6 + .../-companion/index.md | 14 + .../-companion/invalid-url-error.md | 6 + .../-companion/save-failure-error.md | 6 + .../-mini-app-download-file-error.md | 6 + .../-mini-app-download-file-error/code.md | 6 + .../-mini-app-download-file-error/index.md | 28 + .../-mini-app-download-file-error/message.md | 6 + .../-mini-app-download-file-error/type.md | 6 + .../-companion/custom.md | 8 + .../-companion/index.md | 12 + .../-mini-app-points-error.md | 6 + .../-mini-app-points-error/index.md | 27 + .../-mini-app-points-error/message.md | 6 + .../-mini-app-points-error/type.md | 6 + .../index.md | 12 + .../get-camera-permission.md | 8 + .../index.md | 15 + .../request-camera-permission.md | 8 + .../-mini-app-file-chooser-default.md | 15 + .../-mini-app-file-chooser-default/index.md | 37 + .../on-cancel.md | 8 + .../on-received-files.md | 16 + .../on-show-file-chooser.md | 18 + .../request-code.md | 6 + .../-mini-app-file-chooser/index.md | 20 + .../on-show-file-chooser.md | 18 + .../-mini-app-file-downloader-default.md | 14 + .../activity.md | 6 + .../index.md | 37 + .../on-cancel.md | 8 + .../on-received-result.md | 8 + .../on-start-file-download.md | 20 + .../request-code.md | 6 + .../-mini-app-file-downloader/index.md | 20 + .../on-start-file-download.md | 20 + .../index.md | 13 + .../-chat-bridge-dispatcher/index.md | 16 + .../send-message-to-contact-id.md | 8 + .../send-message-to-contact.md | 8 + .../send-message-to-multiple-contacts.md | 8 + .../index.md | 9 + .../-host-app-theme-colors.md | 6 + .../-host-app-theme-colors/index.md | 21 + .../-host-app-theme-colors/primary-color.md | 6 + .../-host-app-theme-colors/secondary-color.md | 6 + .../-companion/custom.md | 8 + .../-companion/index.md | 12 + .../-host-environment-info-error.md | 6 + .../-host-environment-info-error/index.md | 27 + .../-host-environment-info-error/message.md | 6 + .../-host-environment-info-error/type.md | 6 + .../-host-environment-info.md | 8 + .../-host-environment-info/host-locale.md | 6 + .../-host-environment-info/host-version.md | 6 + .../-host-environment-info/index.md | 24 + .../platform-version.md | 6 + .../-host-environment-info/sdk-version.md | 6 + .../index.md | 11 + .../-universal-bridge-info.md | 6 + .../-universal-bridge-info/description.md | 6 + .../-universal-bridge-info/index.md | 22 + .../-universal-bridge-info/key.md | 6 + .../-universal-bridge-info/value.md | 6 + .../index.md | 9 + .../-contact/-contact.md | 6 + .../-contact/all-email-list.md | 6 + .../-contact/email.md | 6 + .../-contact/id.md | 6 + .../-contact/index.md | 23 + .../-contact/name.md | 6 + .../-points/-points.md | 6 + .../-points/cash.md | 6 + .../-points/index.md | 22 + .../-points/standard.md | 6 + .../-points/term.md | 6 + .../-token-data/-token-data.md | 6 + .../-token-data/index.md | 22 + .../-token-data/scopes.md | 6 + .../-token-data/token.md | 6 + .../-token-data/valid-until.md | 6 + .../get-access-token.md | 20 + .../get-contacts.md | 8 + .../get-points.md | 8 + .../get-profile-photo.md | 8 + .../get-user-name.md | 8 + .../-user-info-bridge-dispatcher/index.md | 18 + .../index.md | 12 + .../-message-to-contact.md | 6 + .../-message-to-contact/action.md | 6 + .../-message-to-contact/banner-message.md | 6 + .../-message-to-contact/caption.md | 6 + .../-message-to-contact/image.md | 6 + .../-message-to-contact/index.md | 25 + .../-message-to-contact/is-empty.md | 8 + .../-message-to-contact/text.md | 6 + .../-mini-app-message-bridge.md | 6 + .../allow-screen-orientation.md | 8 + .../did-receive-m-a-analytics.md | 16 + .../dispatch-native-event.md | 8 + .../get-host-app-theme-colors.md | 8 + .../get-host-environment-info.md | 8 + .../get-is-dark-mode.md | 8 + .../-mini-app-message-bridge/get-mauid.md | 8 + .../get-messaging-unique-id.md | 8 + .../-mini-app-message-bridge/get-unique-id.md | 8 + .../-mini-app-message-bridge/index.md | 41 + .../mini-app-should-close.md | 8 + .../-mini-app-message-bridge/post-message.md | 6 + .../request-custom-permissions.md | 17 + .../request-device-permission.md | 8 + .../send-info-to-host-app.md | 16 + .../send-json-to-host-app.md | 16 + .../set-ad-mob-displayer.md | 8 + .../set-chat-bridge-dispatcher.md | 8 + .../set-in-app-purchase-provider.md | 8 + .../set-mini-app-close-listener.md | 8 + .../set-mini-app-file-downloader.md | 8 + .../set-user-info-bridge-dispatcher.md | 8 + .../-mini-app-message-bridge/share-content.md | 17 + .../index.md | 14 + .../-m-i-n-i-a-p-p_-o-n_-p-a-u-s-e/index.md | 14 + .../-m-i-n-i-a-p-p_-o-n_-r-e-s-u-m-e/index.md | 14 + .../index.md | 14 + .../index.md | 14 + .../index.md | 14 + .../-native-event-type/index.md | 27 + .../-native-event-type/value.md | 6 + .../index.md | 11 + .../-external-result-handler.md | 6 + .../-external-result-handler/emit-result.md | 37 + .../-external-result-handler/index.md | 20 + .../-mini-app-download-navigator/index.md | 15 + .../on-file-download-start.md | 24 + .../-companion/index.md | 19 + .../-companion/loader-with-id.md | 17 + .../-companion/loader-with-url.md | 17 + .../-companion/return-url-tag.md | 6 + .../-mini-app-external-url-loader/index.md | 21 + .../should-close.md | 8 + .../should-override-url-loading.md | 8 + .../-mini-app-navigator/index.md | 20 + .../-mini-app-navigator/open-external-url.md | 17 + .../index.md | 12 + .../-access-token-scope.md | 8 + .../-access-token-scope/audience.md | 6 + .../-access-token-scope/index.md | 22 + .../-access-token-scope/scopes.md | 6 + .../-custom-permission-response-obj.md | 6 + .../-custom-permission-response-obj/index.md | 21 + .../-custom-permission-response-obj/name.md | 6 + .../-custom-permission-response-obj/status.md | 6 + .../-mini-app-custom-permission-response.md | 6 + .../index.md | 26 + .../permissions.md | 6 + .../-a-l-l-o-w-e-d/index.md | 13 + .../-d-e-n-i-e-d/index.md | 13 + .../index.md | 13 + .../index.md | 23 + .../-a-c-c-e-s-s_-t-o-k-e-n/index.md | 14 + .../-c-o-n-t-a-c-t_-l-i-s-t/index.md | 14 + .../-f-i-l-e_-d-o-w-n-l-o-a-d/index.md | 14 + .../-l-o-c-a-t-i-o-n/index.md | 14 + .../-p-o-i-n-t-s/index.md | 14 + .../-p-r-o-f-i-l-e_-p-h-o-t-o/index.md | 14 + .../-s-e-n-d_-m-e-s-s-a-g-e/index.md | 14 + .../-u-n-k-n-o-w-n/index.md | 14 + .../-u-s-e-r_-n-a-m-e/index.md | 14 + .../-mini-app-custom-permission-type/index.md | 30 + .../-mini-app-custom-permission-type/type.md | 6 + .../-mini-app-custom-permission.md | 6 + .../-mini-app-custom-permission/index.md | 21 + .../mini-app-id.md | 6 + .../pair-values.md | 6 + .../-c-a-m-e-r-a/index.md | 14 + .../-l-o-c-a-t-i-o-n/index.md | 14 + .../-u-n-k-n-o-w-n/index.md | 14 + .../-mini-app-device-permission-type/index.md | 24 + .../-mini-app-device-permission-type/type.md | 6 + .../index.md | 14 + ...d-signature-verifier-base-url-exception.md | 6 + .../index.md | 34 + ...gnature-verifier-subscription-exception.md | 6 + .../index.md | 34 + .../index.md | 10 + .../-mini-app-config/-mini-app-config.md | 18 + .../-mini-app-config/index.md | 36 + .../-mini-app-config/mini-app-file-chooser.md | 6 + .../mini-app-message-bridge.md | 6 + .../-mini-app-config/mini-app-navigator.md | 6 + .../-mini-app-config/mini-app-sdk-config.md | 6 + .../-mini-app-config/query-params.md | 6 + .../-default-params/-default-params.md | 17 + .../-default-params/config.md | 6 + .../-default-params/context.md | 6 + .../-default-params/from-cache.md | 6 + .../-default-params/index.md | 35 + .../-default-params/mini-app-id.md | 6 + .../-default-params/mini-app-version.md | 6 + .../-info-params/-info-params.md | 17 + .../-info-params/config.md | 6 + .../-info-params/context.md | 6 + .../-info-params/from-cache.md | 6 + .../-info-params/index.md | 34 + .../-info-params/mini-app-info.md | 6 + .../-url-params/-url-params.md | 16 + .../-url-params/config.md | 6 + .../-url-params/context.md | 6 + .../-mini-app-parameters/-url-params/index.md | 32 + .../-url-params/mini-app-url.md | 6 + .../-mini-app-parameters/index.md | 24 + .../-mini-app-view/-companion/index.md | 12 + .../-mini-app-view/-companion/init.md | 16 + .../-mini-app-view/index.md | 22 + .../-mini-app-view/load-from-bundle.md | 17 + .../-mini-app-view/load.md | 18 + .../-mini-app-view/send-json-to-mini-app.md | 17 + .../index.md | 11 + .../-host/-host.md | 6 + .../-host/id.md | 9 + .../-host/index.md | 28 + .../-host/subscription-key.md | 9 + .../-invalid-mini-app-info-exception.md | 6 + .../-invalid-mini-app-info-exception/index.md | 34 + .../-mini-app-bundle-not-found-exception.md | 6 + .../index.md | 34 + .../-mini-app-display/destroy-view.md | 16 + .../-mini-app-display/get-mini-app-view.md | 26 + .../-mini-app-display/index.md | 18 + .../-mini-app-display/navigate-backward.md | 8 + .../-mini-app-display/navigate-forward.md | 8 + .../send-json-to-mini-app.md | 16 + .../-mini-app-has-corrupted-exception.md | 6 + .../index.md | 34 + ...-app-has-no-published-version-exception.md | 6 + .../index.md | 34 + .../-mini-app-host-exception.md | 6 + .../-mini-app-host-exception/index.md | 34 + .../-mini-app-info/-companion/index.md | 6 + .../-mini-app-info/-mini-app-info.md | 6 + .../-mini-app-info/display-name.md | 9 + .../-mini-app-info/icon.md | 9 + .../-mini-app-info/id.md | 9 + .../-mini-app-info/index.md | 38 + .../-mini-app-info/promotional-image-url.md | 9 + .../-mini-app-info/promotional-text.md | 9 + .../-mini-app-info/version.md | 9 + .../-mini-app-manifest/-mini-app-manifest.md | 6 + .../access-token-permissions.md | 6 + .../-mini-app-manifest/custom-meta-data.md | 6 + .../-mini-app-manifest/index.md | 24 + .../optional-permissions.md | 6 + .../required-permissions.md | 6 + .../-mini-app-manifest/version-id.md | 6 + .../-mini-app-net-exception.md | 10 + .../-mini-app-net-exception/index.md | 38 + .../-mini-app-not-found-exception.md | 6 + .../-mini-app-not-found-exception/index.md | 34 + .../-mini-app-sdk-config.md | 6 + .../-mini-app-sdk-config/base-url.md | 6 + .../-mini-app-sdk-config/enable-h5-ads.md | 6 + .../host-app-user-agent-info.md | 6 + .../host-app-version-id.md | 6 + .../-mini-app-sdk-config/index.md | 37 + .../-mini-app-sdk-config/is-preview-mode.md | 6 + .../max-storage-size-limit-in-bytes.md | 6 + .../mini-app-analytics-config-list.md | 6 + .../-mini-app-sdk-config/ras-project-id.md | 6 + .../require-signature-verification.md | 6 + .../ssl-pinning-public-key-list.md | 6 + .../-mini-app-sdk-config/subscription-key.md | 6 + .../-mini-app-sdk-exception.md | 10 + .../-mini-app-sdk-exception/index.md | 52 + .../-mini-app-too-many-requests-error.md | 6 + .../index.md | 34 + .../-mini-app-verification-exception.md | 6 + .../-mini-app-verification-exception/index.md | 34 + .../-mini-app/-companion/index.md | 12 + .../-mini-app/-companion/instance.md | 15 + .../-mini-app/clear-secure-storage.md | 17 + .../-mini-app/clear-secure-storages.md | 16 + .../-mini-app/create-with-url.md | 27 + .../-mini-app/create.md | 57 + .../-mini-app/download-mini-app.md | 18 + .../-mini-app/fetch-info.md | 20 + .../-mini-app/get-custom-permissions.md | 20 + .../-mini-app/get-downloaded-manifest.md | 20 + .../get-mini-app-info-by-preview-code.md | 18 + .../-mini-app/get-mini-app-manifest.md | 22 + .../-mini-app/index.md | 34 + .../-mini-app/is-mini-app-cache-available.md | 17 + ...list-downloaded-with-custom-permissions.md | 12 + .../-mini-app/list-mini-app.md | 18 + .../-mini-app/set-custom-permissions.md | 16 + .../-mini-app/unzip-bundle.md | 19 + .../-preview-mini-app-info.md | 6 + .../-preview-mini-app-info/host.md | 9 + .../-preview-mini-app-info/index.md | 28 + .../-preview-mini-app-info/miniapp.md | 9 + ...uired-permissions-not-granted-exception.md | 6 + .../index.md | 34 + .../-s-s-l-certificate-pinning-exception.md | 6 + .../index.md | 34 + .../-version/-version.md | 6 + .../-version/index.md | 28 + .../-version/version-id.md | 9 + .../-version/version-tag.md | 9 + .../com.rakuten.tech.mobile.miniapp/index.md | 28 + docs/5.6/api/miniapp/package-list | 378 +++++ docs/5.6/index.md | 1399 +++++++++++++++++ 356 files changed, 6493 insertions(+) create mode 100644 _versions/5.6.md create mode 100644 docs/5.6/api/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-action-type/-a-d-d/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-action-type/-c-h-a-n-g-e/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-action-type/-c-l-o-s-e/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-action-type/-d-e-l-e-t-e/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-action-type/-o-p-e-n/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-action-type/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-event-type/-a-p-p-e-a-r/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-event-type/-c-l-i-c-k/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-event-type/-c-u-s-t-o-m/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-event-type/-e-r-r-o-r/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-event-type/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/-m-a-analytics-info.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/action-type.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/component-name.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/data.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/element-type.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/event-type.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/page-name.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/-mini-app-analytics-config.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/acc.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/aid.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.closealert/-mini-app-close-alert-info/-mini-app-close-alert-info.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.closealert/-mini-app-close-alert-info/description.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.closealert/-mini-app-close-alert-info/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.closealert/-mini-app-close-alert-info/should-display.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.closealert/-mini-app-close-alert-info/title.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.closealert/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.display/-mini-app-default-file-provider/-mini-app-default-file-provider.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.display/-mini-app-default-file-provider/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.display/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/-companion/audience-not-supported-error.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/-companion/authorization-failure-error.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/-companion/custom.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/-companion/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/-companion/scopes-not-supported-error.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/-mini-app-access-token-error.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/message.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/type.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-bridge-error/-mini-app-bridge-error.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-bridge-error/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/-companion/download-failed-error.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/-companion/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/-companion/invalid-url-error.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/-companion/save-failure-error.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/-mini-app-download-file-error.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/code.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/message.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/type.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-points-error/-companion/custom.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-points-error/-companion/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-points-error/-mini-app-points-error.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-points-error/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-points-error/message.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-points-error/type.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-camera-permission-dispatcher/get-camera-permission.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-camera-permission-dispatcher/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-camera-permission-dispatcher/request-camera-permission.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser-default/-mini-app-file-chooser-default.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser-default/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser-default/on-cancel.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser-default/on-received-files.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser-default/on-show-file-chooser.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser-default/request-code.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser/on-show-file-chooser.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader-default/-mini-app-file-downloader-default.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader-default/activity.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader-default/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader-default/on-cancel.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader-default/on-received-result.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader-default/on-start-file-download.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader-default/request-code.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader/on-start-file-download.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.chat/-chat-bridge-dispatcher/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.chat/-chat-bridge-dispatcher/send-message-to-contact-id.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.chat/-chat-bridge-dispatcher/send-message-to-contact.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.chat/-chat-bridge-dispatcher/send-message-to-multiple-contacts.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.chat/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-app-theme-colors/-host-app-theme-colors.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-app-theme-colors/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-app-theme-colors/primary-color.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-app-theme-colors/secondary-color.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info-error/-companion/custom.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info-error/-companion/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info-error/-host-environment-info-error.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info-error/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info-error/message.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info-error/type.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info/-host-environment-info.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info/host-locale.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info/host-version.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info/platform-version.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info/sdk-version.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.universalbridge/-universal-bridge-info/-universal-bridge-info.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.universalbridge/-universal-bridge-info/description.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.universalbridge/-universal-bridge-info/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.universalbridge/-universal-bridge-info/key.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.universalbridge/-universal-bridge-info/value.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.universalbridge/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-contact/-contact.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-contact/all-email-list.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-contact/email.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-contact/id.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-contact/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-contact/name.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-points/-points.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-points/cash.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-points/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-points/standard.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-points/term.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-token-data/-token-data.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-token-data/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-token-data/scopes.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-token-data/token.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-token-data/valid-until.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-user-info-bridge-dispatcher/get-access-token.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-user-info-bridge-dispatcher/get-contacts.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-user-info-bridge-dispatcher/get-points.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-user-info-bridge-dispatcher/get-profile-photo.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-user-info-bridge-dispatcher/get-user-name.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-user-info-bridge-dispatcher/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-message-to-contact/-message-to-contact.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-message-to-contact/action.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-message-to-contact/banner-message.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-message-to-contact/caption.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-message-to-contact/image.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-message-to-contact/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-message-to-contact/is-empty.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-message-to-contact/text.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/-mini-app-message-bridge.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/allow-screen-orientation.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/did-receive-m-a-analytics.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/dispatch-native-event.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/get-host-app-theme-colors.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/get-host-environment-info.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/get-is-dark-mode.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/get-mauid.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/get-messaging-unique-id.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/get-unique-id.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/mini-app-should-close.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/post-message.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/request-custom-permissions.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/request-device-permission.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/send-info-to-host-app.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/send-json-to-host-app.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/set-ad-mob-displayer.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/set-chat-bridge-dispatcher.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/set-in-app-purchase-provider.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/set-mini-app-close-listener.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/set-mini-app-file-downloader.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/set-user-info-bridge-dispatcher.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/share-content.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-native-event-type/-e-x-t-e-r-n-a-l_-w-e-b-v-i-e-w_-c-l-o-s-e/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-native-event-type/-m-i-n-i-a-p-p_-o-n_-p-a-u-s-e/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-native-event-type/-m-i-n-i-a-p-p_-o-n_-r-e-s-u-m-e/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-native-event-type/-m-i-n-i-a-p-p_-r-e-c-e-i-v-e_-j-s-o-n_-i-n-f-o/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-native-event-type/-m-i-n-i-a-p-p_-s-e-c-u-r-e_-s-t-o-r-a-g-e_-l-o-a-d_-e-r-r-o-r/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-native-event-type/-m-i-n-i-a-p-p_-s-e-c-u-r-e_-s-t-o-r-a-g-e_-r-e-a-d-y/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-native-event-type/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-native-event-type/value.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-external-result-handler/-external-result-handler.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-external-result-handler/emit-result.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-external-result-handler/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-download-navigator/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-download-navigator/on-file-download-start.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-external-url-loader/-companion/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-external-url-loader/-companion/loader-with-id.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-external-url-loader/-companion/loader-with-url.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-external-url-loader/-companion/return-url-tag.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-external-url-loader/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-external-url-loader/should-close.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-external-url-loader/should-override-url-loading.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-navigator/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-navigator/open-external-url.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-access-token-scope/-access-token-scope.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-access-token-scope/audience.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-access-token-scope/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-access-token-scope/scopes.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-response/-custom-permission-response-obj/-custom-permission-response-obj.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-response/-custom-permission-response-obj/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-response/-custom-permission-response-obj/name.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-response/-custom-permission-response-obj/status.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-response/-mini-app-custom-permission-response.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-response/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-response/permissions.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-d-e-n-i-e-d/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-p-e-r-m-i-s-s-i-o-n_-n-o-t_-a-v-a-i-l-a-b-l-e/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-a-c-c-e-s-s_-t-o-k-e-n/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-c-o-n-t-a-c-t_-l-i-s-t/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-f-i-l-e_-d-o-w-n-l-o-a-d/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-l-o-c-a-t-i-o-n/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-p-o-i-n-t-s/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-p-r-o-f-i-l-e_-p-h-o-t-o/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-s-e-n-d_-m-e-s-s-a-g-e/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-u-n-k-n-o-w-n/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-u-s-e-r_-n-a-m-e/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/type.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission/-mini-app-custom-permission.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission/mini-app-id.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission/pair-values.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-device-permission-type/-c-a-m-e-r-a/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-device-permission-type/-l-o-c-a-t-i-o-n/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-device-permission-type/-u-n-k-n-o-w-n/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-device-permission-type/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-device-permission-type/type.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-base-url-exception/-invalid-signature-verifier-base-url-exception.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-base-url-exception/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/-invalid-signature-verifier-subscription-exception.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.signatureverifier.api/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-config/-mini-app-config.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-config/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-config/mini-app-file-chooser.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-config/mini-app-message-bridge.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-config/mini-app-navigator.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-config/mini-app-sdk-config.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-config/query-params.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-default-params/-default-params.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-default-params/config.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-default-params/context.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-default-params/from-cache.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-default-params/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-default-params/mini-app-id.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-default-params/mini-app-version.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-info-params/-info-params.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-info-params/config.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-info-params/context.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-info-params/from-cache.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-info-params/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-info-params/mini-app-info.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-url-params/-url-params.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-url-params/config.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-url-params/context.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-url-params/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-url-params/mini-app-url.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-view/-companion/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-view/-companion/init.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-view/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-view/load-from-bundle.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-view/load.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-view/send-json-to-mini-app.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-host/-host.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-host/id.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-host/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-host/subscription-key.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-invalid-mini-app-info-exception/-invalid-mini-app-info-exception.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-invalid-mini-app-info-exception/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-bundle-not-found-exception/-mini-app-bundle-not-found-exception.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-bundle-not-found-exception/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-display/destroy-view.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-display/get-mini-app-view.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-display/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-display/navigate-backward.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-display/navigate-forward.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-display/send-json-to-mini-app.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-has-corrupted-exception/-mini-app-has-corrupted-exception.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-has-corrupted-exception/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-has-no-published-version-exception/-mini-app-has-no-published-version-exception.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-has-no-published-version-exception/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-host-exception/-mini-app-host-exception.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-host-exception/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/-companion/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/-mini-app-info.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/display-name.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/icon.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/id.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/promotional-image-url.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/promotional-text.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/version.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-manifest/-mini-app-manifest.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-manifest/access-token-permissions.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-manifest/custom-meta-data.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-manifest/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-manifest/optional-permissions.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-manifest/required-permissions.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-manifest/version-id.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-net-exception/-mini-app-net-exception.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-net-exception/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-not-found-exception/-mini-app-not-found-exception.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-not-found-exception/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/-mini-app-sdk-config.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/base-url.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/enable-h5-ads.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/host-app-user-agent-info.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/host-app-version-id.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/is-preview-mode.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/max-storage-size-limit-in-bytes.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/mini-app-analytics-config-list.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/ras-project-id.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/require-signature-verification.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/ssl-pinning-public-key-list.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/subscription-key.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-exception/-mini-app-sdk-exception.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-exception/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-too-many-requests-error/-mini-app-too-many-requests-error.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-too-many-requests-error/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-verification-exception/-mini-app-verification-exception.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-verification-exception/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/-companion/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/-companion/instance.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/clear-secure-storage.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/clear-secure-storages.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/create-with-url.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/create.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/download-mini-app.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/fetch-info.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/get-custom-permissions.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/get-downloaded-manifest.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/get-mini-app-info-by-preview-code.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/get-mini-app-manifest.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/is-mini-app-cache-available.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/list-downloaded-with-custom-permissions.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/list-mini-app.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/set-custom-permissions.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/unzip-bundle.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-preview-mini-app-info/-preview-mini-app-info.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-preview-mini-app-info/host.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-preview-mini-app-info/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-preview-mini-app-info/miniapp.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-required-permissions-not-granted-exception/-required-permissions-not-granted-exception.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-required-permissions-not-granted-exception/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-s-s-l-certificate-pinning-exception/-s-s-l-certificate-pinning-exception.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-s-s-l-certificate-pinning-exception/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-version/-version.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-version/index.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-version/version-id.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-version/version-tag.md create mode 100644 docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/index.md create mode 100644 docs/5.6/api/miniapp/package-list create mode 100644 docs/5.6/index.md diff --git a/_versions/5.6.md b/_versions/5.6.md new file mode 100644 index 000000000..f1537bdcf --- /dev/null +++ b/_versions/5.6.md @@ -0,0 +1,3 @@ +--- +version: 5.6 +--- \ No newline at end of file diff --git a/docs/5.6/api/index.md b/docs/5.6/api/index.md new file mode 100644 index 000000000..1a47824b0 --- /dev/null +++ b/docs/5.6/api/index.md @@ -0,0 +1,23 @@ +//[miniapp](index.md) + +# miniapp + +## Packages + +| Name | +|---| +| [com.rakuten.tech.mobile.miniapp](miniapp/com.rakuten.tech.mobile.miniapp/index.md) | +| [com.rakuten.tech.mobile.miniapp.analytics](miniapp/com.rakuten.tech.mobile.miniapp.analytics/index.md) | +| [com.rakuten.tech.mobile.miniapp.closealert](miniapp/com.rakuten.tech.mobile.miniapp.closealert/index.md) | +| [com.rakuten.tech.mobile.miniapp.display](miniapp/com.rakuten.tech.mobile.miniapp.display/index.md) | +| [com.rakuten.tech.mobile.miniapp.errors](miniapp/com.rakuten.tech.mobile.miniapp.errors/index.md) | +| [com.rakuten.tech.mobile.miniapp.file](miniapp/com.rakuten.tech.mobile.miniapp.file/index.md) | +| [com.rakuten.tech.mobile.miniapp.js](miniapp/com.rakuten.tech.mobile.miniapp.js/index.md) | +| [com.rakuten.tech.mobile.miniapp.js.chat](miniapp/com.rakuten.tech.mobile.miniapp.js.chat/index.md) | +| [com.rakuten.tech.mobile.miniapp.js.hostenvironment](miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/index.md) | +| [com.rakuten.tech.mobile.miniapp.js.universalbridge](miniapp/com.rakuten.tech.mobile.miniapp.js.universalbridge/index.md) | +| [com.rakuten.tech.mobile.miniapp.js.userinfo](miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/index.md) | +| [com.rakuten.tech.mobile.miniapp.navigator](miniapp/com.rakuten.tech.mobile.miniapp.navigator/index.md) | +| [com.rakuten.tech.mobile.miniapp.permission](miniapp/com.rakuten.tech.mobile.miniapp.permission/index.md) | +| [com.rakuten.tech.mobile.miniapp.signatureverifier.api](miniapp/com.rakuten.tech.mobile.miniapp.signatureverifier.api/index.md) | +| [com.rakuten.tech.mobile.miniapp.view](miniapp/com.rakuten.tech.mobile.miniapp.view/index.md) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-action-type/-a-d-d/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-action-type/-a-d-d/index.md new file mode 100644 index 000000000..30f6372d4 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-action-type/-a-d-d/index.md @@ -0,0 +1,15 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.analytics](../../index.md)/[MAAnalyticsActionType](../index.md)/[ADD](index.md) + +# ADD + +[androidJvm]\ +@SerializedName(value = "add") + +[ADD](index.md)() + +## Properties + +| Name | Summary | +|---|---| +| [name](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739) | [androidJvm]
val [name](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739) | [androidJvm]
val [ordinal](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-action-type/-c-h-a-n-g-e/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-action-type/-c-h-a-n-g-e/index.md new file mode 100644 index 000000000..8c18aed14 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-action-type/-c-h-a-n-g-e/index.md @@ -0,0 +1,15 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.analytics](../../index.md)/[MAAnalyticsActionType](../index.md)/[CHANGE](index.md) + +# CHANGE + +[androidJvm]\ +@SerializedName(value = "change") + +[CHANGE](index.md)() + +## Properties + +| Name | Summary | +|---|---| +| [name](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739) | [androidJvm]
val [name](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739) | [androidJvm]
val [ordinal](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-action-type/-c-l-o-s-e/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-action-type/-c-l-o-s-e/index.md new file mode 100644 index 000000000..1cfdbd065 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-action-type/-c-l-o-s-e/index.md @@ -0,0 +1,15 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.analytics](../../index.md)/[MAAnalyticsActionType](../index.md)/[CLOSE](index.md) + +# CLOSE + +[androidJvm]\ +@SerializedName(value = "close") + +[CLOSE](index.md)() + +## Properties + +| Name | Summary | +|---|---| +| [name](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739) | [androidJvm]
val [name](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739) | [androidJvm]
val [ordinal](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-action-type/-d-e-l-e-t-e/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-action-type/-d-e-l-e-t-e/index.md new file mode 100644 index 000000000..9a26b5d11 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-action-type/-d-e-l-e-t-e/index.md @@ -0,0 +1,15 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.analytics](../../index.md)/[MAAnalyticsActionType](../index.md)/[DELETE](index.md) + +# DELETE + +[androidJvm]\ +@SerializedName(value = "delete") + +[DELETE](index.md)() + +## Properties + +| Name | Summary | +|---|---| +| [name](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739) | [androidJvm]
val [name](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739) | [androidJvm]
val [ordinal](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-action-type/-o-p-e-n/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-action-type/-o-p-e-n/index.md new file mode 100644 index 000000000..1e6af3c7a --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-action-type/-o-p-e-n/index.md @@ -0,0 +1,15 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.analytics](../../index.md)/[MAAnalyticsActionType](../index.md)/[OPEN](index.md) + +# OPEN + +[androidJvm]\ +@SerializedName(value = "open") + +[OPEN](index.md)() + +## Properties + +| Name | Summary | +|---|---| +| [name](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739) | [androidJvm]
val [name](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739) | [androidJvm]
val [ordinal](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-action-type/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-action-type/index.md new file mode 100644 index 000000000..670e2006d --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-action-type/index.md @@ -0,0 +1,25 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.analytics](../index.md)/[MAAnalyticsActionType](index.md) + +# MAAnalyticsActionType + +[androidJvm]\ +enum [MAAnalyticsActionType](index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[MAAnalyticsActionType](index.md)> + +Action Type. + +## Entries + +| | | +|---|---| +| [CHANGE](-c-h-a-n-g-e/index.md) | [androidJvm]
@SerializedName(value = "change")
[CHANGE](-c-h-a-n-g-e/index.md)() | +| [DELETE](-d-e-l-e-t-e/index.md) | [androidJvm]
@SerializedName(value = "delete")
[DELETE](-d-e-l-e-t-e/index.md)() | +| [ADD](-a-d-d/index.md) | [androidJvm]
@SerializedName(value = "add")
[ADD](-a-d-d/index.md)() | +| [CLOSE](-c-l-o-s-e/index.md) | [androidJvm]
@SerializedName(value = "close")
[CLOSE](-c-l-o-s-e/index.md)() | +| [OPEN](-o-p-e-n/index.md) | [androidJvm]
@SerializedName(value = "open")
[OPEN](-o-p-e-n/index.md)() | + +## Properties + +| Name | Summary | +|---|---| +| [name](../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739) | [androidJvm]
val [name](../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739) | [androidJvm]
val [ordinal](../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-event-type/-a-p-p-e-a-r/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-event-type/-a-p-p-e-a-r/index.md new file mode 100644 index 000000000..5d2428134 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-event-type/-a-p-p-e-a-r/index.md @@ -0,0 +1,15 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.analytics](../../index.md)/[MAAnalyticsEventType](../index.md)/[APPEAR](index.md) + +# APPEAR + +[androidJvm]\ +@SerializedName(value = "appear") + +[APPEAR](index.md)() + +## Properties + +| Name | Summary | +|---|---| +| [name](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739) | [androidJvm]
val [name](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739) | [androidJvm]
val [ordinal](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-event-type/-c-l-i-c-k/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-event-type/-c-l-i-c-k/index.md new file mode 100644 index 000000000..a13c76913 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-event-type/-c-l-i-c-k/index.md @@ -0,0 +1,15 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.analytics](../../index.md)/[MAAnalyticsEventType](../index.md)/[CLICK](index.md) + +# CLICK + +[androidJvm]\ +@SerializedName(value = "click") + +[CLICK](index.md)() + +## Properties + +| Name | Summary | +|---|---| +| [name](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739) | [androidJvm]
val [name](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739) | [androidJvm]
val [ordinal](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-event-type/-c-u-s-t-o-m/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-event-type/-c-u-s-t-o-m/index.md new file mode 100644 index 000000000..d3971b06f --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-event-type/-c-u-s-t-o-m/index.md @@ -0,0 +1,15 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.analytics](../../index.md)/[MAAnalyticsEventType](../index.md)/[CUSTOM](index.md) + +# CUSTOM + +[androidJvm]\ +@SerializedName(value = "custom") + +[CUSTOM](index.md)() + +## Properties + +| Name | Summary | +|---|---| +| [name](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739) | [androidJvm]
val [name](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739) | [androidJvm]
val [ordinal](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-event-type/-e-r-r-o-r/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-event-type/-e-r-r-o-r/index.md new file mode 100644 index 000000000..28a2d898b --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-event-type/-e-r-r-o-r/index.md @@ -0,0 +1,15 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.analytics](../../index.md)/[MAAnalyticsEventType](../index.md)/[ERROR](index.md) + +# ERROR + +[androidJvm]\ +@SerializedName(value = "error") + +[ERROR](index.md)() + +## Properties + +| Name | Summary | +|---|---| +| [name](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739) | [androidJvm]
val [name](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739) | [androidJvm]
val [ordinal](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-event-type/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-event-type/index.md new file mode 100644 index 000000000..6a5b60937 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-event-type/index.md @@ -0,0 +1,24 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.analytics](../index.md)/[MAAnalyticsEventType](index.md) + +# MAAnalyticsEventType + +[androidJvm]\ +enum [MAAnalyticsEventType](index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[MAAnalyticsEventType](index.md)> + +Event Type. + +## Entries + +| | | +|---|---| +| [CUSTOM](-c-u-s-t-o-m/index.md) | [androidJvm]
@SerializedName(value = "custom")
[CUSTOM](-c-u-s-t-o-m/index.md)() | +| [ERROR](-e-r-r-o-r/index.md) | [androidJvm]
@SerializedName(value = "error")
[ERROR](-e-r-r-o-r/index.md)() | +| [CLICK](-c-l-i-c-k/index.md) | [androidJvm]
@SerializedName(value = "click")
[CLICK](-c-l-i-c-k/index.md)() | +| [APPEAR](-a-p-p-e-a-r/index.md) | [androidJvm]
@SerializedName(value = "appear")
[APPEAR](-a-p-p-e-a-r/index.md)() | + +## Properties + +| Name | Summary | +|---|---| +| [name](../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739) | [androidJvm]
val [name](../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739) | [androidJvm]
val [ordinal](../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/-m-a-analytics-info.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/-m-a-analytics-info.md new file mode 100644 index 000000000..5e792d8eb --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/-m-a-analytics-info.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.analytics](../index.md)/[MAAnalyticsInfo](index.md)/[MAAnalyticsInfo](-m-a-analytics-info.md) + +# MAAnalyticsInfo + +[androidJvm]\ +fun [MAAnalyticsInfo](-m-a-analytics-info.md)(eventType: [MAAnalyticsEventType](../-m-a-analytics-event-type/index.md), actionType: [MAAnalyticsActionType](../-m-a-analytics-action-type/index.md), pageName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), componentName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), elementType: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), data: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/action-type.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/action-type.md new file mode 100644 index 000000000..c2baef032 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/action-type.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.analytics](../index.md)/[MAAnalyticsInfo](index.md)/[actionType](action-type.md) + +# actionType + +[androidJvm]\ +val [actionType](action-type.md): [MAAnalyticsActionType](../-m-a-analytics-action-type/index.md) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/component-name.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/component-name.md new file mode 100644 index 000000000..38ccb6350 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/component-name.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.analytics](../index.md)/[MAAnalyticsInfo](index.md)/[componentName](component-name.md) + +# componentName + +[androidJvm]\ +val [componentName](component-name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/data.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/data.md new file mode 100644 index 000000000..c589a4fe1 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/data.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.analytics](../index.md)/[MAAnalyticsInfo](index.md)/[data](data.md) + +# data + +[androidJvm]\ +val [data](data.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/element-type.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/element-type.md new file mode 100644 index 000000000..b91493fc3 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/element-type.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.analytics](../index.md)/[MAAnalyticsInfo](index.md)/[elementType](element-type.md) + +# elementType + +[androidJvm]\ +val [elementType](element-type.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/event-type.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/event-type.md new file mode 100644 index 000000000..3401660df --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/event-type.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.analytics](../index.md)/[MAAnalyticsInfo](index.md)/[eventType](event-type.md) + +# eventType + +[androidJvm]\ +val [eventType](event-type.md): [MAAnalyticsEventType](../-m-a-analytics-event-type/index.md) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/index.md new file mode 100644 index 000000000..d929a7aaf --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/index.md @@ -0,0 +1,25 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.analytics](../index.md)/[MAAnalyticsInfo](index.md) + +# MAAnalyticsInfo + +[androidJvm]\ +data class [MAAnalyticsInfo](index.md)(eventType: [MAAnalyticsEventType](../-m-a-analytics-event-type/index.md), actionType: [MAAnalyticsActionType](../-m-a-analytics-action-type/index.md), pageName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), componentName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), elementType: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), data: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) + +Mini App Analytics info type. + +## Constructors + +| | | +|---|---| +| [MAAnalyticsInfo](-m-a-analytics-info.md) | [androidJvm]
fun [MAAnalyticsInfo](-m-a-analytics-info.md)(eventType: [MAAnalyticsEventType](../-m-a-analytics-event-type/index.md), actionType: [MAAnalyticsActionType](../-m-a-analytics-action-type/index.md), pageName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), componentName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), elementType: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), data: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) | + +## Properties + +| Name | Summary | +|---|---| +| [actionType](action-type.md) | [androidJvm]
val [actionType](action-type.md): [MAAnalyticsActionType](../-m-a-analytics-action-type/index.md) | +| [componentName](component-name.md) | [androidJvm]
val [componentName](component-name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [data](data.md) | [androidJvm]
val [data](data.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [elementType](element-type.md) | [androidJvm]
val [elementType](element-type.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [eventType](event-type.md) | [androidJvm]
val [eventType](event-type.md): [MAAnalyticsEventType](../-m-a-analytics-event-type/index.md) | +| [pageName](page-name.md) | [androidJvm]
val [pageName](page-name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/page-name.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/page-name.md new file mode 100644 index 000000000..3da25ab99 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/page-name.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.analytics](../index.md)/[MAAnalyticsInfo](index.md)/[pageName](page-name.md) + +# pageName + +[androidJvm]\ +val [pageName](page-name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/-mini-app-analytics-config.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/-mini-app-analytics-config.md new file mode 100644 index 000000000..b346c31ec --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/-mini-app-analytics-config.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.analytics](../index.md)/[MiniAppAnalyticsConfig](index.md)/[MiniAppAnalyticsConfig](-mini-app-analytics-config.md) + +# MiniAppAnalyticsConfig + +[androidJvm]\ +fun [MiniAppAnalyticsConfig](-mini-app-analytics-config.md)(acc: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), aid: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/acc.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/acc.md new file mode 100644 index 000000000..a3be0bdde --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/acc.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.analytics](../index.md)/[MiniAppAnalyticsConfig](index.md)/[acc](acc.md) + +# acc + +[androidJvm]\ +val [acc](acc.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/aid.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/aid.md new file mode 100644 index 000000000..2d1274509 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/aid.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.analytics](../index.md)/[MiniAppAnalyticsConfig](index.md)/[aid](aid.md) + +# aid + +[androidJvm]\ +val [aid](aid.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/index.md new file mode 100644 index 000000000..df6f4adba --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/index.md @@ -0,0 +1,28 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.analytics](../index.md)/[MiniAppAnalyticsConfig](index.md) + +# MiniAppAnalyticsConfig + +[androidJvm]\ +data class [MiniAppAnalyticsConfig](index.md)(acc: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), aid: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) : [Parcelable](https://developer.android.com/reference/kotlin/android/os/Parcelable.html) + +Contains the components which need to add extra analytics credentials from host app. + +## Constructors + +| | | +|---|---| +| [MiniAppAnalyticsConfig](-mini-app-analytics-config.md) | [androidJvm]
fun [MiniAppAnalyticsConfig](-mini-app-analytics-config.md)(acc: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), aid: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) | + +## Functions + +| Name | Summary | +|---|---| +| [describeContents](index.md#-1578325224%2FFunctions%2F1451286739) | [androidJvm]
abstract fun [describeContents](index.md#-1578325224%2FFunctions%2F1451286739)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [writeToParcel](index.md#-1754457655%2FFunctions%2F1451286739) | [androidJvm]
abstract fun [writeToParcel](index.md#-1754457655%2FFunctions%2F1451286739)(p0: [Parcel](https://developer.android.com/reference/kotlin/android/os/Parcel.html), p1: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) | + +## Properties + +| Name | Summary | +|---|---| +| [acc](acc.md) | [androidJvm]
val [acc](acc.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
The RAT account id. | +| [aid](aid.md) | [androidJvm]
val [aid](aid.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
The RAT app id. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/index.md new file mode 100644 index 000000000..60ab68b27 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.analytics/index.md @@ -0,0 +1,12 @@ +//[miniapp](../../index.md)/[com.rakuten.tech.mobile.miniapp.analytics](index.md) + +# Package com.rakuten.tech.mobile.miniapp.analytics + +## Types + +| Name | Summary | +|---|---| +| [MAAnalyticsActionType](-m-a-analytics-action-type/index.md) | [androidJvm]
enum [MAAnalyticsActionType](-m-a-analytics-action-type/index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[MAAnalyticsActionType](-m-a-analytics-action-type/index.md)>
Action Type. | +| [MAAnalyticsEventType](-m-a-analytics-event-type/index.md) | [androidJvm]
enum [MAAnalyticsEventType](-m-a-analytics-event-type/index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[MAAnalyticsEventType](-m-a-analytics-event-type/index.md)>
Event Type. | +| [MAAnalyticsInfo](-m-a-analytics-info/index.md) | [androidJvm]
data class [MAAnalyticsInfo](-m-a-analytics-info/index.md)(eventType: [MAAnalyticsEventType](-m-a-analytics-event-type/index.md), actionType: [MAAnalyticsActionType](-m-a-analytics-action-type/index.md), pageName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), componentName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), elementType: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), data: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html))
Mini App Analytics info type. | +| [MiniAppAnalyticsConfig](-mini-app-analytics-config/index.md) | [androidJvm]
data class [MiniAppAnalyticsConfig](-mini-app-analytics-config/index.md)(acc: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), aid: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) : [Parcelable](https://developer.android.com/reference/kotlin/android/os/Parcelable.html)
Contains the components which need to add extra analytics credentials from host app. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.closealert/-mini-app-close-alert-info/-mini-app-close-alert-info.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.closealert/-mini-app-close-alert-info/-mini-app-close-alert-info.md new file mode 100644 index 000000000..3a0d6faf0 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.closealert/-mini-app-close-alert-info/-mini-app-close-alert-info.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.closealert](../index.md)/[MiniAppCloseAlertInfo](index.md)/[MiniAppCloseAlertInfo](-mini-app-close-alert-info.md) + +# MiniAppCloseAlertInfo + +[androidJvm]\ +fun [MiniAppCloseAlertInfo](-mini-app-close-alert-info.md)(shouldDisplay: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false, title: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = "", description: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = "") diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.closealert/-mini-app-close-alert-info/description.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.closealert/-mini-app-close-alert-info/description.md new file mode 100644 index 000000000..e5f1bafe7 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.closealert/-mini-app-close-alert-info/description.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.closealert](../index.md)/[MiniAppCloseAlertInfo](index.md)/[description](description.md) + +# description + +[androidJvm]\ +var [description](description.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.closealert/-mini-app-close-alert-info/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.closealert/-mini-app-close-alert-info/index.md new file mode 100644 index 000000000..7c9d1e33e --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.closealert/-mini-app-close-alert-info/index.md @@ -0,0 +1,22 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.closealert](../index.md)/[MiniAppCloseAlertInfo](index.md) + +# MiniAppCloseAlertInfo + +[androidJvm]\ +data class [MiniAppCloseAlertInfo](index.md)(shouldDisplay: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), title: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), description: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) + +An object to prepare information of close alert popup. + +## Constructors + +| | | +|---|---| +| [MiniAppCloseAlertInfo](-mini-app-close-alert-info.md) | [androidJvm]
fun [MiniAppCloseAlertInfo](-mini-app-close-alert-info.md)(shouldDisplay: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false, title: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = "", description: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = "") | + +## Properties + +| Name | Summary | +|---|---| +| [description](description.md) | [androidJvm]
var [description](description.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [shouldDisplay](should-display.md) | [androidJvm]
var [shouldDisplay](should-display.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false | +| [title](title.md) | [androidJvm]
var [title](title.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.closealert/-mini-app-close-alert-info/should-display.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.closealert/-mini-app-close-alert-info/should-display.md new file mode 100644 index 000000000..bae0d0caa --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.closealert/-mini-app-close-alert-info/should-display.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.closealert](../index.md)/[MiniAppCloseAlertInfo](index.md)/[shouldDisplay](should-display.md) + +# shouldDisplay + +[androidJvm]\ +var [shouldDisplay](should-display.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.closealert/-mini-app-close-alert-info/title.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.closealert/-mini-app-close-alert-info/title.md new file mode 100644 index 000000000..fabd1e91a --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.closealert/-mini-app-close-alert-info/title.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.closealert](../index.md)/[MiniAppCloseAlertInfo](index.md)/[title](title.md) + +# title + +[androidJvm]\ +var [title](title.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.closealert/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.closealert/index.md new file mode 100644 index 000000000..68e4fa0a0 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.closealert/index.md @@ -0,0 +1,9 @@ +//[miniapp](../../index.md)/[com.rakuten.tech.mobile.miniapp.closealert](index.md) + +# Package com.rakuten.tech.mobile.miniapp.closealert + +## Types + +| Name | Summary | +|---|---| +| [MiniAppCloseAlertInfo](-mini-app-close-alert-info/index.md) | [androidJvm]
data class [MiniAppCloseAlertInfo](-mini-app-close-alert-info/index.md)(shouldDisplay: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), title: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), description: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html))
An object to prepare information of close alert popup. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.display/-mini-app-default-file-provider/-mini-app-default-file-provider.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.display/-mini-app-default-file-provider/-mini-app-default-file-provider.md new file mode 100644 index 000000000..40ead929f --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.display/-mini-app-default-file-provider/-mini-app-default-file-provider.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.display](../index.md)/[MiniAppDefaultFileProvider](index.md)/[MiniAppDefaultFileProvider](-mini-app-default-file-provider.md) + +# MiniAppDefaultFileProvider + +[androidJvm]\ +fun [MiniAppDefaultFileProvider](-mini-app-default-file-provider.md)() diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.display/-mini-app-default-file-provider/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.display/-mini-app-default-file-provider/index.md new file mode 100644 index 000000000..84dc44c53 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.display/-mini-app-default-file-provider/index.md @@ -0,0 +1,59 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.display](../index.md)/[MiniAppDefaultFileProvider](index.md) + +# MiniAppDefaultFileProvider + +[androidJvm]\ +class [MiniAppDefaultFileProvider](index.md) : [FileProvider](https://developer.android.com/reference/kotlin/androidx/core/content/FileProvider.html) + +Default FileProvider of MiniApp SDK. + +## Constructors + +| | | +|---|---| +| [MiniAppDefaultFileProvider](-mini-app-default-file-provider.md) | [androidJvm]
fun [MiniAppDefaultFileProvider](-mini-app-default-file-provider.md)() | + +## Functions + +| Name | Summary | +|---|---| +| [applyBatch](index.md#-579436093%2FFunctions%2F1451286739) | [androidJvm]
open fun [applyBatch](index.md#-579436093%2FFunctions%2F1451286739)(p0: [ArrayList](https://developer.android.com/reference/kotlin/java/util/ArrayList.html)<[ContentProviderOperation](https://developer.android.com/reference/kotlin/android/content/ContentProviderOperation.html)>): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[ContentProviderResult](https://developer.android.com/reference/kotlin/android/content/ContentProviderResult.html)>
open fun [applyBatch](index.md#-211330584%2FFunctions%2F1451286739)(p0: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), p1: [ArrayList](https://developer.android.com/reference/kotlin/java/util/ArrayList.html)<[ContentProviderOperation](https://developer.android.com/reference/kotlin/android/content/ContentProviderOperation.html)>): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[ContentProviderResult](https://developer.android.com/reference/kotlin/android/content/ContentProviderResult.html)> | +| [attachInfo](index.md#634307526%2FFunctions%2F1451286739) | [androidJvm]
open override fun [attachInfo](index.md#634307526%2FFunctions%2F1451286739)(@[NonNull](https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html)context: [Context](https://developer.android.com/reference/kotlin/android/content/Context.html), @[NonNull](https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html)info: [ProviderInfo](https://developer.android.com/reference/kotlin/android/content/pm/ProviderInfo.html)) | +| [bulkInsert](index.md#968421164%2FFunctions%2F1451286739) | [androidJvm]
open fun [bulkInsert](index.md#968421164%2FFunctions%2F1451286739)(p0: [Uri](https://developer.android.com/reference/kotlin/android/net/Uri.html), p1: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[ContentValues](https://developer.android.com/reference/kotlin/android/content/ContentValues.html)>): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [call](index.md#-1577313746%2FFunctions%2F1451286739) | [androidJvm]
open fun [call](index.md#-1577313746%2FFunctions%2F1451286739)(p0: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), p1: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, p2: [Bundle](https://developer.android.com/reference/kotlin/android/os/Bundle.html)?): [Bundle](https://developer.android.com/reference/kotlin/android/os/Bundle.html)?
open fun [call](index.md#1889531795%2FFunctions%2F1451286739)(p0: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), p1: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), p2: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, p3: [Bundle](https://developer.android.com/reference/kotlin/android/os/Bundle.html)?): [Bundle](https://developer.android.com/reference/kotlin/android/os/Bundle.html)? | +| [canonicalize](index.md#-167066941%2FFunctions%2F1451286739) | [androidJvm]
open fun [canonicalize](index.md#-167066941%2FFunctions%2F1451286739)(p0: [Uri](https://developer.android.com/reference/kotlin/android/net/Uri.html)): [Uri](https://developer.android.com/reference/kotlin/android/net/Uri.html)? | +| [clearCallingIdentity](index.md#1399480974%2FFunctions%2F1451286739) | [androidJvm]
fun [clearCallingIdentity](index.md#1399480974%2FFunctions%2F1451286739)(): [ContentProvider.CallingIdentity](https://developer.android.com/reference/kotlin/android/content/ContentProvider.CallingIdentity.html) | +| [delete](index.md#-391220161%2FFunctions%2F1451286739) | [androidJvm]
open fun [delete](index.md#-391220161%2FFunctions%2F1451286739)(p0: [Uri](https://developer.android.com/reference/kotlin/android/net/Uri.html), p1: [Bundle](https://developer.android.com/reference/kotlin/android/os/Bundle.html)?): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
open override fun [delete](index.md#1344142630%2FFunctions%2F1451286739)(@[NonNull](https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html)uri: [Uri](https://developer.android.com/reference/kotlin/android/net/Uri.html), @[Nullable](https://developer.android.com/reference/kotlin/androidx/annotation/Nullable.html)selection: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, @[Nullable](https://developer.android.com/reference/kotlin/androidx/annotation/Nullable.html)selectionArgs: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>?): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [dump](index.md#-815388228%2FFunctions%2F1451286739) | [androidJvm]
open fun [dump](index.md#-815388228%2FFunctions%2F1451286739)(p0: [FileDescriptor](https://developer.android.com/reference/kotlin/java/io/FileDescriptor.html), p1: [PrintWriter](https://developer.android.com/reference/kotlin/java/io/PrintWriter.html), p2: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>) | +| [getCallingAttributionSource](index.md#-912193749%2FFunctions%2F1451286739) | [androidJvm]
fun [getCallingAttributionSource](index.md#-912193749%2FFunctions%2F1451286739)(): [AttributionSource](https://developer.android.com/reference/kotlin/android/content/AttributionSource.html)? | +| [getCallingAttributionTag](index.md#365049562%2FFunctions%2F1451286739) | [androidJvm]
fun [getCallingAttributionTag](index.md#365049562%2FFunctions%2F1451286739)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? | +| [getCallingPackage](index.md#-826438689%2FFunctions%2F1451286739) | [androidJvm]
fun [getCallingPackage](index.md#-826438689%2FFunctions%2F1451286739)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? | +| [getCallingPackageUnchecked](index.md#1771303629%2FFunctions%2F1451286739) | [androidJvm]
fun [getCallingPackageUnchecked](index.md#1771303629%2FFunctions%2F1451286739)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? | +| [getContext](index.md#-1176919894%2FFunctions%2F1451286739) | [androidJvm]
fun [getContext](index.md#-1176919894%2FFunctions%2F1451286739)(): [Context](https://developer.android.com/reference/kotlin/android/content/Context.html)? | +| [getPathPermissions](index.md#-484361926%2FFunctions%2F1451286739) | [androidJvm]
fun [getPathPermissions](index.md#-484361926%2FFunctions%2F1451286739)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[PathPermission](https://developer.android.com/reference/kotlin/android/content/pm/PathPermission.html)>? | +| [getReadPermission](index.md#-1549852644%2FFunctions%2F1451286739) | [androidJvm]
fun [getReadPermission](index.md#-1549852644%2FFunctions%2F1451286739)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? | +| [getStreamTypes](index.md#727325547%2FFunctions%2F1451286739) | [androidJvm]
open fun [getStreamTypes](index.md#727325547%2FFunctions%2F1451286739)(p0: [Uri](https://developer.android.com/reference/kotlin/android/net/Uri.html), p1: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>? | +| [getType](index.md#125747895%2FFunctions%2F1451286739) | [androidJvm]
open override fun [getType](index.md#125747895%2FFunctions%2F1451286739)(@[NonNull](https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html)uri: [Uri](https://developer.android.com/reference/kotlin/android/net/Uri.html)): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? | +| [getWritePermission](index.md#1196057643%2FFunctions%2F1451286739) | [androidJvm]
fun [getWritePermission](index.md#1196057643%2FFunctions%2F1451286739)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? | +| [insert](index.md#980582787%2FFunctions%2F1451286739) | [androidJvm]
open override fun [insert](index.md#980582787%2FFunctions%2F1451286739)(@[NonNull](https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html)uri: [Uri](https://developer.android.com/reference/kotlin/android/net/Uri.html), values: [ContentValues](https://developer.android.com/reference/kotlin/android/content/ContentValues.html)?): [Uri](https://developer.android.com/reference/kotlin/android/net/Uri.html)?
open fun [insert](index.md#-111143934%2FFunctions%2F1451286739)(p0: [Uri](https://developer.android.com/reference/kotlin/android/net/Uri.html), p1: [ContentValues](https://developer.android.com/reference/kotlin/android/content/ContentValues.html)?, p2: [Bundle](https://developer.android.com/reference/kotlin/android/os/Bundle.html)?): [Uri](https://developer.android.com/reference/kotlin/android/net/Uri.html)? | +| [isTemporary](index.md#-1635027504%2FFunctions%2F1451286739) | [androidJvm]
open fun [isTemporary](index.md#-1635027504%2FFunctions%2F1451286739)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [onCallingPackageChanged](index.md#-196343868%2FFunctions%2F1451286739) | [androidJvm]
open fun [onCallingPackageChanged](index.md#-196343868%2FFunctions%2F1451286739)() | +| [onConfigurationChanged](index.md#955605224%2FFunctions%2F1451286739) | [androidJvm]
open override fun [onConfigurationChanged](index.md#955605224%2FFunctions%2F1451286739)(p0: [Configuration](https://developer.android.com/reference/kotlin/android/content/res/Configuration.html)) | +| [onCreate](index.md#-1001465472%2FFunctions%2F1451286739) | [androidJvm]
open override fun [onCreate](index.md#-1001465472%2FFunctions%2F1451286739)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [onLowMemory](index.md#594123425%2FFunctions%2F1451286739) | [androidJvm]
open override fun [onLowMemory](index.md#594123425%2FFunctions%2F1451286739)() | +| [onTrimMemory](index.md#-1357851105%2FFunctions%2F1451286739) | [androidJvm]
open override fun [onTrimMemory](index.md#-1357851105%2FFunctions%2F1451286739)(p0: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) | +| [openAssetFile](index.md#-1270087754%2FFunctions%2F1451286739) | [androidJvm]
open fun [openAssetFile](index.md#-1270087754%2FFunctions%2F1451286739)(p0: [Uri](https://developer.android.com/reference/kotlin/android/net/Uri.html), p1: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [AssetFileDescriptor](https://developer.android.com/reference/kotlin/android/content/res/AssetFileDescriptor.html)?
open fun [openAssetFile](index.md#1807943200%2FFunctions%2F1451286739)(p0: [Uri](https://developer.android.com/reference/kotlin/android/net/Uri.html), p1: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), p2: [CancellationSignal](https://developer.android.com/reference/kotlin/android/os/CancellationSignal.html)?): [AssetFileDescriptor](https://developer.android.com/reference/kotlin/android/content/res/AssetFileDescriptor.html)? | +| [openFile](index.md#-1800699498%2FFunctions%2F1451286739) | [androidJvm]
open override fun [openFile](index.md#-1800699498%2FFunctions%2F1451286739)(@[NonNull](https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html)uri: [Uri](https://developer.android.com/reference/kotlin/android/net/Uri.html), @[NonNull](https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html)mode: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [ParcelFileDescriptor](https://developer.android.com/reference/kotlin/android/os/ParcelFileDescriptor.html)?
open fun [openFile](index.md#2047861992%2FFunctions%2F1451286739)(p0: [Uri](https://developer.android.com/reference/kotlin/android/net/Uri.html), p1: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), p2: [CancellationSignal](https://developer.android.com/reference/kotlin/android/os/CancellationSignal.html)?): [ParcelFileDescriptor](https://developer.android.com/reference/kotlin/android/os/ParcelFileDescriptor.html)? | +| [openFileHelper](index.md#414967612%2FFunctions%2F1451286739) | [androidJvm]
fun [openFileHelper](index.md#414967612%2FFunctions%2F1451286739)(p0: [Uri](https://developer.android.com/reference/kotlin/android/net/Uri.html), p1: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [ParcelFileDescriptor](https://developer.android.com/reference/kotlin/android/os/ParcelFileDescriptor.html) | +| [openPipeHelper](index.md#-1948715849%2FFunctions%2F1451286739) | [androidJvm]
open fun <[T](index.md#-1948715849%2FFunctions%2F1451286739) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [openPipeHelper](index.md#-1948715849%2FFunctions%2F1451286739)(p0: [Uri](https://developer.android.com/reference/kotlin/android/net/Uri.html), p1: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), p2: [Bundle](https://developer.android.com/reference/kotlin/android/os/Bundle.html)?, p3: [T](index.md#-1948715849%2FFunctions%2F1451286739)?, p4: [ContentProvider.PipeDataWriter](https://developer.android.com/reference/kotlin/android/content/ContentProvider.PipeDataWriter.html)<[T](index.md#-1948715849%2FFunctions%2F1451286739)>): [ParcelFileDescriptor](https://developer.android.com/reference/kotlin/android/os/ParcelFileDescriptor.html) | +| [openTypedAssetFile](index.md#1446480217%2FFunctions%2F1451286739) | [androidJvm]
open fun [openTypedAssetFile](index.md#1446480217%2FFunctions%2F1451286739)(p0: [Uri](https://developer.android.com/reference/kotlin/android/net/Uri.html), p1: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), p2: [Bundle](https://developer.android.com/reference/kotlin/android/os/Bundle.html)?): [AssetFileDescriptor](https://developer.android.com/reference/kotlin/android/content/res/AssetFileDescriptor.html)?
open fun [openTypedAssetFile](index.md#-715192291%2FFunctions%2F1451286739)(p0: [Uri](https://developer.android.com/reference/kotlin/android/net/Uri.html), p1: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), p2: [Bundle](https://developer.android.com/reference/kotlin/android/os/Bundle.html)?, p3: [CancellationSignal](https://developer.android.com/reference/kotlin/android/os/CancellationSignal.html)?): [AssetFileDescriptor](https://developer.android.com/reference/kotlin/android/content/res/AssetFileDescriptor.html)? | +| [query](index.md#830025184%2FFunctions%2F1451286739) | [androidJvm]
open fun [query](index.md#830025184%2FFunctions%2F1451286739)(p0: [Uri](https://developer.android.com/reference/kotlin/android/net/Uri.html), p1: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>?, p2: [Bundle](https://developer.android.com/reference/kotlin/android/os/Bundle.html)?, p3: [CancellationSignal](https://developer.android.com/reference/kotlin/android/os/CancellationSignal.html)?): [Cursor](https://developer.android.com/reference/kotlin/android/database/Cursor.html)?
open override fun [query](index.md#-990492305%2FFunctions%2F1451286739)(@[NonNull](https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html)uri: [Uri](https://developer.android.com/reference/kotlin/android/net/Uri.html), @[Nullable](https://developer.android.com/reference/kotlin/androidx/annotation/Nullable.html)projection: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>?, @[Nullable](https://developer.android.com/reference/kotlin/androidx/annotation/Nullable.html)selection: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, @[Nullable](https://developer.android.com/reference/kotlin/androidx/annotation/Nullable.html)selectionArgs: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>?, @[Nullable](https://developer.android.com/reference/kotlin/androidx/annotation/Nullable.html)sortOrder: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?): [Cursor](https://developer.android.com/reference/kotlin/android/database/Cursor.html)?
open fun [query](index.md#-1450681441%2FFunctions%2F1451286739)(p0: [Uri](https://developer.android.com/reference/kotlin/android/net/Uri.html), p1: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>?, p2: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, p3: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>?, p4: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, p5: [CancellationSignal](https://developer.android.com/reference/kotlin/android/os/CancellationSignal.html)?): [Cursor](https://developer.android.com/reference/kotlin/android/database/Cursor.html)? | +| [refresh](index.md#-1477190157%2FFunctions%2F1451286739) | [androidJvm]
open fun [refresh](index.md#-1477190157%2FFunctions%2F1451286739)(p0: [Uri](https://developer.android.com/reference/kotlin/android/net/Uri.html), p1: [Bundle](https://developer.android.com/reference/kotlin/android/os/Bundle.html)?, p2: [CancellationSignal](https://developer.android.com/reference/kotlin/android/os/CancellationSignal.html)?): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [requireContext](index.md#-1640266823%2FFunctions%2F1451286739) | [androidJvm]
fun [requireContext](index.md#-1640266823%2FFunctions%2F1451286739)(): [Context](https://developer.android.com/reference/kotlin/android/content/Context.html) | +| [restoreCallingIdentity](index.md#-139189815%2FFunctions%2F1451286739) | [androidJvm]
fun [restoreCallingIdentity](index.md#-139189815%2FFunctions%2F1451286739)(p0: [ContentProvider.CallingIdentity](https://developer.android.com/reference/kotlin/android/content/ContentProvider.CallingIdentity.html)) | +| [setPathPermissions](index.md#847672994%2FFunctions%2F1451286739) | [androidJvm]
fun [setPathPermissions](index.md#847672994%2FFunctions%2F1451286739)(p0: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[PathPermission](https://developer.android.com/reference/kotlin/android/content/pm/PathPermission.html)>?) | +| [setReadPermission](index.md#992069615%2FFunctions%2F1451286739) | [androidJvm]
fun [setReadPermission](index.md#992069615%2FFunctions%2F1451286739)(p0: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) | +| [setWritePermission](index.md#-670707882%2FFunctions%2F1451286739) | [androidJvm]
fun [setWritePermission](index.md#-670707882%2FFunctions%2F1451286739)(p0: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) | +| [shutdown](index.md#643934189%2FFunctions%2F1451286739) | [androidJvm]
open fun [shutdown](index.md#643934189%2FFunctions%2F1451286739)() | +| [uncanonicalize](index.md#893497436%2FFunctions%2F1451286739) | [androidJvm]
open fun [uncanonicalize](index.md#893497436%2FFunctions%2F1451286739)(p0: [Uri](https://developer.android.com/reference/kotlin/android/net/Uri.html)): [Uri](https://developer.android.com/reference/kotlin/android/net/Uri.html)? | +| [update](index.md#1860212242%2FFunctions%2F1451286739) | [androidJvm]
open fun [update](index.md#1860212242%2FFunctions%2F1451286739)(p0: [Uri](https://developer.android.com/reference/kotlin/android/net/Uri.html), p1: [ContentValues](https://developer.android.com/reference/kotlin/android/content/ContentValues.html)?, p2: [Bundle](https://developer.android.com/reference/kotlin/android/os/Bundle.html)?): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
open override fun [update](index.md#-388312477%2FFunctions%2F1451286739)(@[NonNull](https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html)uri: [Uri](https://developer.android.com/reference/kotlin/android/net/Uri.html), values: [ContentValues](https://developer.android.com/reference/kotlin/android/content/ContentValues.html)?, @[Nullable](https://developer.android.com/reference/kotlin/androidx/annotation/Nullable.html)selection: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, @[Nullable](https://developer.android.com/reference/kotlin/androidx/annotation/Nullable.html)selectionArgs: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>?): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.display/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.display/index.md new file mode 100644 index 000000000..bc24035b3 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.display/index.md @@ -0,0 +1,9 @@ +//[miniapp](../../index.md)/[com.rakuten.tech.mobile.miniapp.display](index.md) + +# Package com.rakuten.tech.mobile.miniapp.display + +## Types + +| Name | Summary | +|---|---| +| [MiniAppDefaultFileProvider](-mini-app-default-file-provider/index.md) | [androidJvm]
class [MiniAppDefaultFileProvider](-mini-app-default-file-provider/index.md) : [FileProvider](https://developer.android.com/reference/kotlin/androidx/core/content/FileProvider.html)
Default FileProvider of MiniApp SDK. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/-companion/audience-not-supported-error.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/-companion/audience-not-supported-error.md new file mode 100644 index 000000000..309b73678 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/-companion/audience-not-supported-error.md @@ -0,0 +1,6 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.errors](../../index.md)/[MiniAppAccessTokenError](../index.md)/[Companion](index.md)/[audienceNotSupportedError](audience-not-supported-error.md) + +# audienceNotSupportedError + +[androidJvm]\ +val [audienceNotSupportedError](audience-not-supported-error.md): [MiniAppAccessTokenError](../index.md) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/-companion/authorization-failure-error.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/-companion/authorization-failure-error.md new file mode 100644 index 000000000..7cdb06506 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/-companion/authorization-failure-error.md @@ -0,0 +1,8 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.errors](../../index.md)/[MiniAppAccessTokenError](../index.md)/[Companion](index.md)/[authorizationFailureError](authorization-failure-error.md) + +# authorizationFailureError + +[androidJvm]\ +fun [authorizationFailureError](authorization-failure-error.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [MiniAppAccessTokenError](../index.md) + +send custom error message for authorization fail from host app. diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/-companion/custom.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/-companion/custom.md new file mode 100644 index 000000000..2628d2749 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/-companion/custom.md @@ -0,0 +1,8 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.errors](../../index.md)/[MiniAppAccessTokenError](../index.md)/[Companion](index.md)/[custom](custom.md) + +# custom + +[androidJvm]\ +fun [custom](custom.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [MiniAppAccessTokenError](../index.md) + +send custom error message from host app. diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/-companion/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/-companion/index.md new file mode 100644 index 000000000..968420ea4 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/-companion/index.md @@ -0,0 +1,20 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.errors](../../index.md)/[MiniAppAccessTokenError](../index.md)/[Companion](index.md) + +# Companion + +[androidJvm]\ +object [Companion](index.md) + +## Functions + +| Name | Summary | +|---|---| +| [authorizationFailureError](authorization-failure-error.md) | [androidJvm]
fun [authorizationFailureError](authorization-failure-error.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [MiniAppAccessTokenError](../index.md)
send custom error message for authorization fail from host app. | +| [custom](custom.md) | [androidJvm]
fun [custom](custom.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [MiniAppAccessTokenError](../index.md)
send custom error message from host app. | + +## Properties + +| Name | Summary | +|---|---| +| [audienceNotSupportedError](audience-not-supported-error.md) | [androidJvm]
val [audienceNotSupportedError](audience-not-supported-error.md): [MiniAppAccessTokenError](../index.md) | +| [scopesNotSupportedError](scopes-not-supported-error.md) | [androidJvm]
val [scopesNotSupportedError](scopes-not-supported-error.md): [MiniAppAccessTokenError](../index.md) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/-companion/scopes-not-supported-error.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/-companion/scopes-not-supported-error.md new file mode 100644 index 000000000..ebbdf87c4 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/-companion/scopes-not-supported-error.md @@ -0,0 +1,6 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.errors](../../index.md)/[MiniAppAccessTokenError](../index.md)/[Companion](index.md)/[scopesNotSupportedError](scopes-not-supported-error.md) + +# scopesNotSupportedError + +[androidJvm]\ +val [scopesNotSupportedError](scopes-not-supported-error.md): [MiniAppAccessTokenError](../index.md) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/-mini-app-access-token-error.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/-mini-app-access-token-error.md new file mode 100644 index 000000000..c4484774a --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/-mini-app-access-token-error.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.errors](../index.md)/[MiniAppAccessTokenError](index.md)/[MiniAppAccessTokenError](-mini-app-access-token-error.md) + +# MiniAppAccessTokenError + +[androidJvm]\ +fun [MiniAppAccessTokenError](-mini-app-access-token-error.md)(type: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/index.md new file mode 100644 index 000000000..baf943ab0 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/index.md @@ -0,0 +1,27 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.errors](../index.md)/[MiniAppAccessTokenError](index.md) + +# MiniAppAccessTokenError + +[androidJvm]\ +class [MiniAppAccessTokenError](index.md)(type: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) : [MiniAppBridgeError](../-mini-app-bridge-error/index.md) + +A class to provide the custom errors specific for access token. + +## Constructors + +| | | +|---|---| +| [MiniAppAccessTokenError](-mini-app-access-token-error.md) | [androidJvm]
fun [MiniAppAccessTokenError](-mini-app-access-token-error.md)(type: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null) | + +## Types + +| Name | Summary | +|---|---| +| [Companion](-companion/index.md) | [androidJvm]
object [Companion](-companion/index.md) | + +## Properties + +| Name | Summary | +|---|---| +| [message](message.md) | [androidJvm]
val [message](message.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null | +| [type](type.md) | [androidJvm]
val [type](type.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/message.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/message.md new file mode 100644 index 000000000..b1aa93dbc --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/message.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.errors](../index.md)/[MiniAppAccessTokenError](index.md)/[message](message.md) + +# message + +[androidJvm]\ +val [message](message.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/type.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/type.md new file mode 100644 index 000000000..cabca6440 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/type.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.errors](../index.md)/[MiniAppAccessTokenError](index.md)/[type](type.md) + +# type + +[androidJvm]\ +val [type](type.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-bridge-error/-mini-app-bridge-error.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-bridge-error/-mini-app-bridge-error.md new file mode 100644 index 000000000..d331c44ac --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-bridge-error/-mini-app-bridge-error.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.errors](../index.md)/[MiniAppBridgeError](index.md)/[MiniAppBridgeError](-mini-app-bridge-error.md) + +# MiniAppBridgeError + +[androidJvm]\ +fun [MiniAppBridgeError](-mini-app-bridge-error.md)(type: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-bridge-error/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-bridge-error/index.md new file mode 100644 index 000000000..4719a4a2e --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-bridge-error/index.md @@ -0,0 +1,23 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.errors](../index.md)/[MiniAppBridgeError](index.md) + +# MiniAppBridgeError + +[androidJvm]\ +open class [MiniAppBridgeError](index.md)(type: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) + +Contains the components to use custom errors from host app. + +## Constructors + +| | | +|---|---| +| [MiniAppBridgeError](-mini-app-bridge-error.md) | [androidJvm]
fun [MiniAppBridgeError](-mini-app-bridge-error.md)(type: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) | + +## Inheritors + +| Name | +|---| +| [MiniAppAccessTokenError](../-mini-app-access-token-error/index.md) | +| [MiniAppDownloadFileError](../-mini-app-download-file-error/index.md) | +| [MiniAppPointsError](../-mini-app-points-error/index.md) | +| [HostEnvironmentInfoError](../../com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info-error/index.md) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/-companion/download-failed-error.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/-companion/download-failed-error.md new file mode 100644 index 000000000..a778e0bc1 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/-companion/download-failed-error.md @@ -0,0 +1,6 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.errors](../../index.md)/[MiniAppDownloadFileError](../index.md)/[Companion](index.md)/[downloadFailedError](download-failed-error.md) + +# downloadFailedError + +[androidJvm]\ +val [downloadFailedError](download-failed-error.md): [MiniAppDownloadFileError](../index.md) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/-companion/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/-companion/index.md new file mode 100644 index 000000000..40ab8399f --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/-companion/index.md @@ -0,0 +1,14 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.errors](../../index.md)/[MiniAppDownloadFileError](../index.md)/[Companion](index.md) + +# Companion + +[androidJvm]\ +object [Companion](index.md) + +## Properties + +| Name | Summary | +|---|---| +| [downloadFailedError](download-failed-error.md) | [androidJvm]
val [downloadFailedError](download-failed-error.md): [MiniAppDownloadFileError](../index.md) | +| [invalidUrlError](invalid-url-error.md) | [androidJvm]
val [invalidUrlError](invalid-url-error.md): [MiniAppDownloadFileError](../index.md) | +| [saveFailureError](save-failure-error.md) | [androidJvm]
val [saveFailureError](save-failure-error.md): [MiniAppDownloadFileError](../index.md) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/-companion/invalid-url-error.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/-companion/invalid-url-error.md new file mode 100644 index 000000000..2dc030afb --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/-companion/invalid-url-error.md @@ -0,0 +1,6 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.errors](../../index.md)/[MiniAppDownloadFileError](../index.md)/[Companion](index.md)/[invalidUrlError](invalid-url-error.md) + +# invalidUrlError + +[androidJvm]\ +val [invalidUrlError](invalid-url-error.md): [MiniAppDownloadFileError](../index.md) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/-companion/save-failure-error.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/-companion/save-failure-error.md new file mode 100644 index 000000000..2072e9177 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/-companion/save-failure-error.md @@ -0,0 +1,6 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.errors](../../index.md)/[MiniAppDownloadFileError](../index.md)/[Companion](index.md)/[saveFailureError](save-failure-error.md) + +# saveFailureError + +[androidJvm]\ +val [saveFailureError](save-failure-error.md): [MiniAppDownloadFileError](../index.md) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/-mini-app-download-file-error.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/-mini-app-download-file-error.md new file mode 100644 index 000000000..dc4052ee1 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/-mini-app-download-file-error.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.errors](../index.md)/[MiniAppDownloadFileError](index.md)/[MiniAppDownloadFileError](-mini-app-download-file-error.md) + +# MiniAppDownloadFileError + +[androidJvm]\ +fun [MiniAppDownloadFileError](-mini-app-download-file-error.md)(type: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, code: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)? = null) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/code.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/code.md new file mode 100644 index 000000000..e24fb6d19 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/code.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.errors](../index.md)/[MiniAppDownloadFileError](index.md)/[code](code.md) + +# code + +[androidJvm]\ +val [code](code.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)? = null diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/index.md new file mode 100644 index 000000000..49ec9f7fa --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/index.md @@ -0,0 +1,28 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.errors](../index.md)/[MiniAppDownloadFileError](index.md) + +# MiniAppDownloadFileError + +[androidJvm]\ +class [MiniAppDownloadFileError](index.md)(type: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, code: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)?) : [MiniAppBridgeError](../-mini-app-bridge-error/index.md) + +A class to provide the custom errors specific for file download. + +## Constructors + +| | | +|---|---| +| [MiniAppDownloadFileError](-mini-app-download-file-error.md) | [androidJvm]
fun [MiniAppDownloadFileError](-mini-app-download-file-error.md)(type: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, code: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)? = null) | + +## Types + +| Name | Summary | +|---|---| +| [Companion](-companion/index.md) | [androidJvm]
object [Companion](-companion/index.md) | + +## Properties + +| Name | Summary | +|---|---| +| [code](code.md) | [androidJvm]
val [code](code.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)? = null | +| [message](message.md) | [androidJvm]
val [message](message.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null | +| [type](type.md) | [androidJvm]
val [type](type.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/message.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/message.md new file mode 100644 index 000000000..f6d67f472 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/message.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.errors](../index.md)/[MiniAppDownloadFileError](index.md)/[message](message.md) + +# message + +[androidJvm]\ +val [message](message.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/type.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/type.md new file mode 100644 index 000000000..ddf8adf73 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/type.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.errors](../index.md)/[MiniAppDownloadFileError](index.md)/[type](type.md) + +# type + +[androidJvm]\ +val [type](type.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-points-error/-companion/custom.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-points-error/-companion/custom.md new file mode 100644 index 000000000..a5a74b740 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-points-error/-companion/custom.md @@ -0,0 +1,8 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.errors](../../index.md)/[MiniAppPointsError](../index.md)/[Companion](index.md)/[custom](custom.md) + +# custom + +[androidJvm]\ +fun [custom](custom.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [MiniAppPointsError](../index.md) + +send custom error message from host app. diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-points-error/-companion/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-points-error/-companion/index.md new file mode 100644 index 000000000..5c2f543c9 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-points-error/-companion/index.md @@ -0,0 +1,12 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.errors](../../index.md)/[MiniAppPointsError](../index.md)/[Companion](index.md) + +# Companion + +[androidJvm]\ +object [Companion](index.md) + +## Functions + +| Name | Summary | +|---|---| +| [custom](custom.md) | [androidJvm]
fun [custom](custom.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [MiniAppPointsError](../index.md)
send custom error message from host app. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-points-error/-mini-app-points-error.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-points-error/-mini-app-points-error.md new file mode 100644 index 000000000..b0c416997 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-points-error/-mini-app-points-error.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.errors](../index.md)/[MiniAppPointsError](index.md)/[MiniAppPointsError](-mini-app-points-error.md) + +# MiniAppPointsError + +[androidJvm]\ +fun [MiniAppPointsError](-mini-app-points-error.md)(type: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-points-error/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-points-error/index.md new file mode 100644 index 000000000..5b1a03eaf --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-points-error/index.md @@ -0,0 +1,27 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.errors](../index.md)/[MiniAppPointsError](index.md) + +# MiniAppPointsError + +[androidJvm]\ +class [MiniAppPointsError](index.md)(type: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) : [MiniAppBridgeError](../-mini-app-bridge-error/index.md) + +A class to provide the custom errors specific for user's points. + +## Constructors + +| | | +|---|---| +| [MiniAppPointsError](-mini-app-points-error.md) | [androidJvm]
fun [MiniAppPointsError](-mini-app-points-error.md)(type: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null) | + +## Types + +| Name | Summary | +|---|---| +| [Companion](-companion/index.md) | [androidJvm]
object [Companion](-companion/index.md) | + +## Properties + +| Name | Summary | +|---|---| +| [message](message.md) | [androidJvm]
val [message](message.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null | +| [type](type.md) | [androidJvm]
val [type](type.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-points-error/message.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-points-error/message.md new file mode 100644 index 000000000..c3c2f2a5b --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-points-error/message.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.errors](../index.md)/[MiniAppPointsError](index.md)/[message](message.md) + +# message + +[androidJvm]\ +val [message](message.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-points-error/type.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-points-error/type.md new file mode 100644 index 000000000..5d1152f0a --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-points-error/type.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.errors](../index.md)/[MiniAppPointsError](index.md)/[type](type.md) + +# type + +[androidJvm]\ +val [type](type.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/index.md new file mode 100644 index 000000000..48a1506b2 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.errors/index.md @@ -0,0 +1,12 @@ +//[miniapp](../../index.md)/[com.rakuten.tech.mobile.miniapp.errors](index.md) + +# Package com.rakuten.tech.mobile.miniapp.errors + +## Types + +| Name | Summary | +|---|---| +| [MiniAppAccessTokenError](-mini-app-access-token-error/index.md) | [androidJvm]
class [MiniAppAccessTokenError](-mini-app-access-token-error/index.md)(type: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) : [MiniAppBridgeError](-mini-app-bridge-error/index.md)
A class to provide the custom errors specific for access token. | +| [MiniAppBridgeError](-mini-app-bridge-error/index.md) | [androidJvm]
open class [MiniAppBridgeError](-mini-app-bridge-error/index.md)(type: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?)
Contains the components to use custom errors from host app. | +| [MiniAppDownloadFileError](-mini-app-download-file-error/index.md) | [androidJvm]
class [MiniAppDownloadFileError](-mini-app-download-file-error/index.md)(type: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, code: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)?) : [MiniAppBridgeError](-mini-app-bridge-error/index.md)
A class to provide the custom errors specific for file download. | +| [MiniAppPointsError](-mini-app-points-error/index.md) | [androidJvm]
class [MiniAppPointsError](-mini-app-points-error/index.md)(type: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) : [MiniAppBridgeError](-mini-app-bridge-error/index.md)
A class to provide the custom errors specific for user's points. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-camera-permission-dispatcher/get-camera-permission.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-camera-permission-dispatcher/get-camera-permission.md new file mode 100644 index 000000000..037c5fc55 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-camera-permission-dispatcher/get-camera-permission.md @@ -0,0 +1,8 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.file](../index.md)/[MiniAppCameraPermissionDispatcher](index.md)/[getCameraPermission](get-camera-permission.md) + +# getCameraPermission + +[androidJvm]\ +open fun [getCameraPermission](get-camera-permission.md)(permissionCallback: (isGranted: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) + +Get camera permission from host app. You can also throw an [Exception](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html) from this method. diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-camera-permission-dispatcher/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-camera-permission-dispatcher/index.md new file mode 100644 index 000000000..27b63f664 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-camera-permission-dispatcher/index.md @@ -0,0 +1,15 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.file](../index.md)/[MiniAppCameraPermissionDispatcher](index.md) + +# MiniAppCameraPermissionDispatcher + +[androidJvm]\ +interface [MiniAppCameraPermissionDispatcher](index.md) + +A class to provide the interfaces for getting and requesting camera permission. + +## Functions + +| Name | Summary | +|---|---| +| [getCameraPermission](get-camera-permission.md) | [androidJvm]
open fun [getCameraPermission](get-camera-permission.md)(permissionCallback: (isGranted: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
Get camera permission from host app. You can also throw an [Exception](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html) from this method. | +| [requestCameraPermission](request-camera-permission.md) | [androidJvm]
open fun [requestCameraPermission](request-camera-permission.md)(miniAppPermissionType: [MiniAppDevicePermissionType](../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-device-permission-type/index.md), permissionRequestCallback: (isGranted: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
Request camera permission from host app. You can also throw an [Exception](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html) from this method. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-camera-permission-dispatcher/request-camera-permission.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-camera-permission-dispatcher/request-camera-permission.md new file mode 100644 index 000000000..6df11f74d --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-camera-permission-dispatcher/request-camera-permission.md @@ -0,0 +1,8 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.file](../index.md)/[MiniAppCameraPermissionDispatcher](index.md)/[requestCameraPermission](request-camera-permission.md) + +# requestCameraPermission + +[androidJvm]\ +open fun [requestCameraPermission](request-camera-permission.md)(miniAppPermissionType: [MiniAppDevicePermissionType](../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-device-permission-type/index.md), permissionRequestCallback: (isGranted: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) + +Request camera permission from host app. You can also throw an [Exception](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html) from this method. diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser-default/-mini-app-file-chooser-default.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser-default/-mini-app-file-chooser-default.md new file mode 100644 index 000000000..f633af9c7 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser-default/-mini-app-file-chooser-default.md @@ -0,0 +1,15 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.file](../index.md)/[MiniAppFileChooserDefault](index.md)/[MiniAppFileChooserDefault](-mini-app-file-chooser-default.md) + +# MiniAppFileChooserDefault + +[androidJvm]\ +fun [MiniAppFileChooserDefault](-mini-app-file-chooser-default.md)(requestCode: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), miniAppCameraPermissionDispatcher: [MiniAppCameraPermissionDispatcher](../-mini-app-camera-permission-dispatcher/index.md)? = null) + +## Parameters + +androidJvm + +| | | +|---|---| +| requestCode | of file choosing using an intent inside sdk, which will also be used to retrieve the data by [Activity.onActivityResult](https://developer.android.com/reference/kotlin/android/app/Activity.html#onactivityresult) in the HostApp. | +| miniAppCameraPermissionDispatcher | needs to be implemented if HostApp want to access camera from miniapp and HostApp has camera permission in manifest.xml | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser-default/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser-default/index.md new file mode 100644 index 000000000..377ac39cb --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser-default/index.md @@ -0,0 +1,37 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.file](../index.md)/[MiniAppFileChooserDefault](index.md) + +# MiniAppFileChooserDefault + +[androidJvm]\ +class [MiniAppFileChooserDefault](index.md)(requestCode: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), miniAppCameraPermissionDispatcher: [MiniAppCameraPermissionDispatcher](../-mini-app-camera-permission-dispatcher/index.md)?) : [MiniAppFileChooser](../-mini-app-file-chooser/index.md) + +The default file chooser of a miniapp. + +## Parameters + +androidJvm + +| | | +|---|---| +| requestCode | of file choosing using an intent inside sdk, which will also be used to retrieve the data by [Activity.onActivityResult](https://developer.android.com/reference/kotlin/android/app/Activity.html#onactivityresult) in the HostApp. | +| miniAppCameraPermissionDispatcher | needs to be implemented if HostApp want to access camera from miniapp and HostApp has camera permission in manifest.xml | + +## Constructors + +| | | +|---|---| +| [MiniAppFileChooserDefault](-mini-app-file-chooser-default.md) | [androidJvm]
fun [MiniAppFileChooserDefault](-mini-app-file-chooser-default.md)(requestCode: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), miniAppCameraPermissionDispatcher: [MiniAppCameraPermissionDispatcher](../-mini-app-camera-permission-dispatcher/index.md)? = null) | + +## Functions + +| Name | Summary | +|---|---| +| [onCancel](on-cancel.md) | [androidJvm]
fun [onCancel](on-cancel.md)()
Can be used when HostApp wants to cancel the file choosing operation. | +| [onReceivedFiles](on-received-files.md) | [androidJvm]
fun [onReceivedFiles](on-received-files.md)(intent: [Intent](https://developer.android.com/reference/kotlin/android/content/Intent.html)?)
Receive the files from the HostApp. | +| [onShowFileChooser](on-show-file-chooser.md) | [androidJvm]
open override fun [onShowFileChooser](on-show-file-chooser.md)(filePathCallback: [ValueCallback](https://developer.android.com/reference/kotlin/android/webkit/ValueCallback.html)<[Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Uri](https://developer.android.com/reference/kotlin/android/net/Uri.html)>>?, fileChooserParams: [WebChromeClient.FileChooserParams](https://developer.android.com/reference/kotlin/android/webkit/WebChromeClient.FileChooserParams.html)?, context: [Context](https://developer.android.com/reference/kotlin/android/content/Context.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
For choosing the files which has been invoked by [WebChromeClient.onShowFileChooser](https://developer.android.com/reference/kotlin/android/webkit/WebChromeClient.html#onshowfilechooser) inside the miniapp webview. | + +## Properties + +| Name | Summary | +|---|---| +| [requestCode](request-code.md) | [androidJvm]
var [requestCode](request-code.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser-default/on-cancel.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser-default/on-cancel.md new file mode 100644 index 000000000..6b5b40b00 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser-default/on-cancel.md @@ -0,0 +1,8 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.file](../index.md)/[MiniAppFileChooserDefault](index.md)/[onCancel](on-cancel.md) + +# onCancel + +[androidJvm]\ +fun [onCancel](on-cancel.md)() + +Can be used when HostApp wants to cancel the file choosing operation. diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser-default/on-received-files.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser-default/on-received-files.md new file mode 100644 index 000000000..7c6be781e --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser-default/on-received-files.md @@ -0,0 +1,16 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.file](../index.md)/[MiniAppFileChooserDefault](index.md)/[onReceivedFiles](on-received-files.md) + +# onReceivedFiles + +[androidJvm]\ +fun [onReceivedFiles](on-received-files.md)(intent: [Intent](https://developer.android.com/reference/kotlin/android/content/Intent.html)?) + +Receive the files from the HostApp. + +## Parameters + +androidJvm + +| | | +|---|---| +| intent | The data after successfully retrieved by [Activity.onActivityResult](https://developer.android.com/reference/kotlin/android/app/Activity.html#onactivityresult) in the HostApp. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser-default/on-show-file-chooser.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser-default/on-show-file-chooser.md new file mode 100644 index 000000000..dca7fb73f --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser-default/on-show-file-chooser.md @@ -0,0 +1,18 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.file](../index.md)/[MiniAppFileChooserDefault](index.md)/[onShowFileChooser](on-show-file-chooser.md) + +# onShowFileChooser + +[androidJvm]\ +open override fun [onShowFileChooser](on-show-file-chooser.md)(filePathCallback: [ValueCallback](https://developer.android.com/reference/kotlin/android/webkit/ValueCallback.html)<[Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Uri](https://developer.android.com/reference/kotlin/android/net/Uri.html)>>?, fileChooserParams: [WebChromeClient.FileChooserParams](https://developer.android.com/reference/kotlin/android/webkit/WebChromeClient.FileChooserParams.html)?, context: [Context](https://developer.android.com/reference/kotlin/android/content/Context.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +For choosing the files which has been invoked by [WebChromeClient.onShowFileChooser](https://developer.android.com/reference/kotlin/android/webkit/WebChromeClient.html#onshowfilechooser) inside the miniapp webview. + +## Parameters + +androidJvm + +| | | +|---|---| +| filePathCallback | a callback to provide the array of file-paths to select. | +| fileChooserParams | the parameters can be used to customize the options of file chooser. | +| context | the Activity context can be used to start the intent to choose file. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser-default/request-code.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser-default/request-code.md new file mode 100644 index 000000000..83dcb53c7 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser-default/request-code.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.file](../index.md)/[MiniAppFileChooserDefault](index.md)/[requestCode](request-code.md) + +# requestCode + +[androidJvm]\ +var [requestCode](request-code.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser/index.md new file mode 100644 index 000000000..64692bbc4 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser/index.md @@ -0,0 +1,20 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.file](../index.md)/[MiniAppFileChooser](index.md) + +# MiniAppFileChooser + +[androidJvm]\ +interface [MiniAppFileChooser](index.md) + +The file chooser of a miniapp with onShowFileChooser function. + +## Functions + +| Name | Summary | +|---|---| +| [onShowFileChooser](on-show-file-chooser.md) | [androidJvm]
abstract fun [onShowFileChooser](on-show-file-chooser.md)(filePathCallback: [ValueCallback](https://developer.android.com/reference/kotlin/android/webkit/ValueCallback.html)<[Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Uri](https://developer.android.com/reference/kotlin/android/net/Uri.html)>>?, fileChooserParams: [WebChromeClient.FileChooserParams](https://developer.android.com/reference/kotlin/android/webkit/WebChromeClient.FileChooserParams.html)?, context: [Context](https://developer.android.com/reference/kotlin/android/content/Context.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
For choosing the files which has been invoked by [WebChromeClient.onShowFileChooser](https://developer.android.com/reference/kotlin/android/webkit/WebChromeClient.html#onshowfilechooser) inside the miniapp webview. | + +## Inheritors + +| Name | +|---| +| [MiniAppFileChooserDefault](../-mini-app-file-chooser-default/index.md) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser/on-show-file-chooser.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser/on-show-file-chooser.md new file mode 100644 index 000000000..2ce638b99 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser/on-show-file-chooser.md @@ -0,0 +1,18 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.file](../index.md)/[MiniAppFileChooser](index.md)/[onShowFileChooser](on-show-file-chooser.md) + +# onShowFileChooser + +[androidJvm]\ +abstract fun [onShowFileChooser](on-show-file-chooser.md)(filePathCallback: [ValueCallback](https://developer.android.com/reference/kotlin/android/webkit/ValueCallback.html)<[Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Uri](https://developer.android.com/reference/kotlin/android/net/Uri.html)>>?, fileChooserParams: [WebChromeClient.FileChooserParams](https://developer.android.com/reference/kotlin/android/webkit/WebChromeClient.FileChooserParams.html)?, context: [Context](https://developer.android.com/reference/kotlin/android/content/Context.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +For choosing the files which has been invoked by [WebChromeClient.onShowFileChooser](https://developer.android.com/reference/kotlin/android/webkit/WebChromeClient.html#onshowfilechooser) inside the miniapp webview. + +## Parameters + +androidJvm + +| | | +|---|---| +| filePathCallback | a callback to provide the array of file-paths to select. | +| fileChooserParams | the parameters can be used to customize the options of file chooser. | +| context | the Activity context can be used to start the intent to choose file. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader-default/-mini-app-file-downloader-default.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader-default/-mini-app-file-downloader-default.md new file mode 100644 index 000000000..56910a047 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader-default/-mini-app-file-downloader-default.md @@ -0,0 +1,14 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.file](../index.md)/[MiniAppFileDownloaderDefault](index.md)/[MiniAppFileDownloaderDefault](-mini-app-file-downloader-default.md) + +# MiniAppFileDownloaderDefault + +[androidJvm]\ +fun [MiniAppFileDownloaderDefault](-mini-app-file-downloader-default.md)(activity: [Activity](https://developer.android.com/reference/kotlin/android/app/Activity.html), requestCode: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) + +## Parameters + +androidJvm + +| | | +|---|---| +| requestCode | of file downloading using an intent inside sdk, which will also be used to retrieve the Uri of the file by [Activity.onActivityResult](https://developer.android.com/reference/kotlin/android/app/Activity.html#onactivityresult) in the HostApp. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader-default/activity.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader-default/activity.md new file mode 100644 index 000000000..48ecc66f6 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader-default/activity.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.file](../index.md)/[MiniAppFileDownloaderDefault](index.md)/[activity](activity.md) + +# activity + +[androidJvm]\ +var [activity](activity.md): [Activity](https://developer.android.com/reference/kotlin/android/app/Activity.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader-default/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader-default/index.md new file mode 100644 index 000000000..069da7397 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader-default/index.md @@ -0,0 +1,37 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.file](../index.md)/[MiniAppFileDownloaderDefault](index.md) + +# MiniAppFileDownloaderDefault + +[androidJvm]\ +class [MiniAppFileDownloaderDefault](index.md)(activity: [Activity](https://developer.android.com/reference/kotlin/android/app/Activity.html), requestCode: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) : [MiniAppFileDownloader](../-mini-app-file-downloader/index.md) + +The default file downloader of a miniapp. + +## Parameters + +androidJvm + +| | | +|---|---| +| requestCode | of file downloading using an intent inside sdk, which will also be used to retrieve the Uri of the file by [Activity.onActivityResult](https://developer.android.com/reference/kotlin/android/app/Activity.html#onactivityresult) in the HostApp. | + +## Constructors + +| | | +|---|---| +| [MiniAppFileDownloaderDefault](-mini-app-file-downloader-default.md) | [androidJvm]
fun [MiniAppFileDownloaderDefault](-mini-app-file-downloader-default.md)(activity: [Activity](https://developer.android.com/reference/kotlin/android/app/Activity.html), requestCode: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) | + +## Functions + +| Name | Summary | +|---|---| +| [onCancel](on-cancel.md) | [androidJvm]
fun [onCancel](on-cancel.md)()
Can be used when HostApp wants to cancel the file download operation. | +| [onReceivedResult](on-received-result.md) | [androidJvm]
fun [onReceivedResult](on-received-result.md)(destinationUri: [Uri](https://developer.android.com/reference/kotlin/android/net/Uri.html))
Retrieve the Uri of the file by [Activity.onActivityResult](https://developer.android.com/reference/kotlin/android/app/Activity.html#onactivityresult) in the HostApp. | +| [onStartFileDownload](on-start-file-download.md) | [androidJvm]
open override fun [onStartFileDownload](on-start-file-download.md)(fileName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), url: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), headers: [Map](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>, onDownloadSuccess: ([String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), onDownloadFailed: ([MiniAppDownloadFileError](../../com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
For downloading the files which has been invoked by miniapp. | + +## Properties + +| Name | Summary | +|---|---| +| [activity](activity.md) | [androidJvm]
var [activity](activity.md): [Activity](https://developer.android.com/reference/kotlin/android/app/Activity.html) | +| [requestCode](request-code.md) | [androidJvm]
var [requestCode](request-code.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader-default/on-cancel.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader-default/on-cancel.md new file mode 100644 index 000000000..f857e729e --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader-default/on-cancel.md @@ -0,0 +1,8 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.file](../index.md)/[MiniAppFileDownloaderDefault](index.md)/[onCancel](on-cancel.md) + +# onCancel + +[androidJvm]\ +fun [onCancel](on-cancel.md)() + +Can be used when HostApp wants to cancel the file download operation. diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader-default/on-received-result.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader-default/on-received-result.md new file mode 100644 index 000000000..1246b3c39 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader-default/on-received-result.md @@ -0,0 +1,8 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.file](../index.md)/[MiniAppFileDownloaderDefault](index.md)/[onReceivedResult](on-received-result.md) + +# onReceivedResult + +[androidJvm]\ +fun [onReceivedResult](on-received-result.md)(destinationUri: [Uri](https://developer.android.com/reference/kotlin/android/net/Uri.html)) + +Retrieve the Uri of the file by [Activity.onActivityResult](https://developer.android.com/reference/kotlin/android/app/Activity.html#onactivityresult) in the HostApp. diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader-default/on-start-file-download.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader-default/on-start-file-download.md new file mode 100644 index 000000000..ff824598e --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader-default/on-start-file-download.md @@ -0,0 +1,20 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.file](../index.md)/[MiniAppFileDownloaderDefault](index.md)/[onStartFileDownload](on-start-file-download.md) + +# onStartFileDownload + +[androidJvm]\ +open override fun [onStartFileDownload](on-start-file-download.md)(fileName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), url: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), headers: [Map](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>, onDownloadSuccess: ([String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), onDownloadFailed: ([MiniAppDownloadFileError](../../com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) + +For downloading the files which has been invoked by miniapp. + +## Parameters + +androidJvm + +| | | +|---|---| +| fileName | return the name of the file. | +| url | return the download url of the file. | +| headers | returns the header of the file if there is any. | +| onDownloadSuccess | contains file name send from host app to miniapp. | +| onDownloadFailed | contains custom error message send from host app. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader-default/request-code.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader-default/request-code.md new file mode 100644 index 000000000..6093d93de --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader-default/request-code.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.file](../index.md)/[MiniAppFileDownloaderDefault](index.md)/[requestCode](request-code.md) + +# requestCode + +[androidJvm]\ +var [requestCode](request-code.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader/index.md new file mode 100644 index 000000000..bf229cf76 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader/index.md @@ -0,0 +1,20 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.file](../index.md)/[MiniAppFileDownloader](index.md) + +# MiniAppFileDownloader + +[androidJvm]\ +interface [MiniAppFileDownloader](index.md) + +The file downloader of a miniapp with onStartFileDownload function. To start file download on the device. + +## Functions + +| Name | Summary | +|---|---| +| [onStartFileDownload](on-start-file-download.md) | [androidJvm]
abstract fun [onStartFileDownload](on-start-file-download.md)(fileName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), url: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), headers: [Map](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>, onDownloadSuccess: ([String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), onDownloadFailed: ([MiniAppDownloadFileError](../../com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
For downloading the files which has been invoked by miniapp. | + +## Inheritors + +| Name | +|---| +| [MiniAppFileDownloaderDefault](../-mini-app-file-downloader-default/index.md) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader/on-start-file-download.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader/on-start-file-download.md new file mode 100644 index 000000000..2ac4eda06 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader/on-start-file-download.md @@ -0,0 +1,20 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.file](../index.md)/[MiniAppFileDownloader](index.md)/[onStartFileDownload](on-start-file-download.md) + +# onStartFileDownload + +[androidJvm]\ +abstract fun [onStartFileDownload](on-start-file-download.md)(fileName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), url: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), headers: [Map](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>, onDownloadSuccess: ([String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), onDownloadFailed: ([MiniAppDownloadFileError](../../com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) + +For downloading the files which has been invoked by miniapp. + +## Parameters + +androidJvm + +| | | +|---|---| +| fileName | return the name of the file. | +| url | return the download url of the file. | +| headers | returns the header of the file if there is any. | +| onDownloadSuccess | contains file name send from host app to miniapp. | +| onDownloadFailed | contains custom error message send from host app. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/index.md new file mode 100644 index 000000000..d376996da --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.file/index.md @@ -0,0 +1,13 @@ +//[miniapp](../../index.md)/[com.rakuten.tech.mobile.miniapp.file](index.md) + +# Package com.rakuten.tech.mobile.miniapp.file + +## Types + +| Name | Summary | +|---|---| +| [MiniAppCameraPermissionDispatcher](-mini-app-camera-permission-dispatcher/index.md) | [androidJvm]
interface [MiniAppCameraPermissionDispatcher](-mini-app-camera-permission-dispatcher/index.md)
A class to provide the interfaces for getting and requesting camera permission. | +| [MiniAppFileChooser](-mini-app-file-chooser/index.md) | [androidJvm]
interface [MiniAppFileChooser](-mini-app-file-chooser/index.md)
The file chooser of a miniapp with onShowFileChooser function. | +| [MiniAppFileChooserDefault](-mini-app-file-chooser-default/index.md) | [androidJvm]
class [MiniAppFileChooserDefault](-mini-app-file-chooser-default/index.md)(requestCode: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), miniAppCameraPermissionDispatcher: [MiniAppCameraPermissionDispatcher](-mini-app-camera-permission-dispatcher/index.md)?) : [MiniAppFileChooser](-mini-app-file-chooser/index.md)
The default file chooser of a miniapp. | +| [MiniAppFileDownloader](-mini-app-file-downloader/index.md) | [androidJvm]
interface [MiniAppFileDownloader](-mini-app-file-downloader/index.md)
The file downloader of a miniapp with onStartFileDownload function. To start file download on the device. | +| [MiniAppFileDownloaderDefault](-mini-app-file-downloader-default/index.md) | [androidJvm]
class [MiniAppFileDownloaderDefault](-mini-app-file-downloader-default/index.md)(activity: [Activity](https://developer.android.com/reference/kotlin/android/app/Activity.html), requestCode: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) : [MiniAppFileDownloader](-mini-app-file-downloader/index.md)
The default file downloader of a miniapp. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.chat/-chat-bridge-dispatcher/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.chat/-chat-bridge-dispatcher/index.md new file mode 100644 index 000000000..0da260619 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.chat/-chat-bridge-dispatcher/index.md @@ -0,0 +1,16 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.chat](../index.md)/[ChatBridgeDispatcher](index.md) + +# ChatBridgeDispatcher + +[androidJvm]\ +interface [ChatBridgeDispatcher](index.md) + +Functionalities related to Chatting with the contacts. + +## Functions + +| Name | Summary | +|---|---| +| [sendMessageToContact](send-message-to-contact.md) | [androidJvm]
abstract fun [sendMessageToContact](send-message-to-contact.md)(message: [MessageToContact](../../com.rakuten.tech.mobile.miniapp.js/-message-to-contact/index.md), onSuccess: (contactId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), onError: (message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
Triggered when Mini App wants to send a message to a single contact. Should invoke [onSuccess](send-message-to-contact.md) with the contact ID to send the message. If the user wants to cancel sending the message, should invoked [onSuccess](send-message-to-contact.md) with null. Should invoke [onError](send-message-to-contact.md) when there was an error. | +| [sendMessageToContactId](send-message-to-contact-id.md) | [androidJvm]
abstract fun [sendMessageToContactId](send-message-to-contact-id.md)(contactId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), message: [MessageToContact](../../com.rakuten.tech.mobile.miniapp.js/-message-to-contact/index.md), onSuccess: (contactId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), onError: (message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
Triggered when Mini App wants to send a message to a specific contact. Should send a message to the specified contactId without any prompt to the User. Should invoke [onSuccess](send-message-to-contact-id.md) after message was successfully sent. Should invoke [onError](send-message-to-contact-id.md) when there was an error. | +| [sendMessageToMultipleContacts](send-message-to-multiple-contacts.md) | [androidJvm]
abstract fun [sendMessageToMultipleContacts](send-message-to-multiple-contacts.md)(message: [MessageToContact](../../com.rakuten.tech.mobile.miniapp.js/-message-to-contact/index.md), onSuccess: (contactIds: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>?) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), onError: (message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
Triggered when Mini App wants to send a message to multiple contacts. Should open a contact chooser which allows the user to choose multiple contacts, and should then send the message to all chosen contacts. Should invoke [onSuccess](send-message-to-multiple-contacts.md) with a list of IDs of the contacts which were successfully sent the message. If the user cancelled sending the message, should invoked [onSuccess](send-message-to-multiple-contacts.md) with null. Should invoke [onError](send-message-to-multiple-contacts.md) when there was an error. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.chat/-chat-bridge-dispatcher/send-message-to-contact-id.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.chat/-chat-bridge-dispatcher/send-message-to-contact-id.md new file mode 100644 index 000000000..af5730fd5 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.chat/-chat-bridge-dispatcher/send-message-to-contact-id.md @@ -0,0 +1,8 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.chat](../index.md)/[ChatBridgeDispatcher](index.md)/[sendMessageToContactId](send-message-to-contact-id.md) + +# sendMessageToContactId + +[androidJvm]\ +abstract fun [sendMessageToContactId](send-message-to-contact-id.md)(contactId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), message: [MessageToContact](../../com.rakuten.tech.mobile.miniapp.js/-message-to-contact/index.md), onSuccess: (contactId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), onError: (message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) + +Triggered when Mini App wants to send a message to a specific contact. Should send a message to the specified contactId without any prompt to the User. Should invoke [onSuccess](send-message-to-contact-id.md) after message was successfully sent. Should invoke [onError](send-message-to-contact-id.md) when there was an error. diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.chat/-chat-bridge-dispatcher/send-message-to-contact.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.chat/-chat-bridge-dispatcher/send-message-to-contact.md new file mode 100644 index 000000000..01a77377e --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.chat/-chat-bridge-dispatcher/send-message-to-contact.md @@ -0,0 +1,8 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.chat](../index.md)/[ChatBridgeDispatcher](index.md)/[sendMessageToContact](send-message-to-contact.md) + +# sendMessageToContact + +[androidJvm]\ +abstract fun [sendMessageToContact](send-message-to-contact.md)(message: [MessageToContact](../../com.rakuten.tech.mobile.miniapp.js/-message-to-contact/index.md), onSuccess: (contactId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), onError: (message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) + +Triggered when Mini App wants to send a message to a single contact. Should invoke [onSuccess](send-message-to-contact.md) with the contact ID to send the message. If the user wants to cancel sending the message, should invoked [onSuccess](send-message-to-contact.md) with null. Should invoke [onError](send-message-to-contact.md) when there was an error. diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.chat/-chat-bridge-dispatcher/send-message-to-multiple-contacts.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.chat/-chat-bridge-dispatcher/send-message-to-multiple-contacts.md new file mode 100644 index 000000000..422329caa --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.chat/-chat-bridge-dispatcher/send-message-to-multiple-contacts.md @@ -0,0 +1,8 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.chat](../index.md)/[ChatBridgeDispatcher](index.md)/[sendMessageToMultipleContacts](send-message-to-multiple-contacts.md) + +# sendMessageToMultipleContacts + +[androidJvm]\ +abstract fun [sendMessageToMultipleContacts](send-message-to-multiple-contacts.md)(message: [MessageToContact](../../com.rakuten.tech.mobile.miniapp.js/-message-to-contact/index.md), onSuccess: (contactIds: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>?) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), onError: (message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) + +Triggered when Mini App wants to send a message to multiple contacts. Should open a contact chooser which allows the user to choose multiple contacts, and should then send the message to all chosen contacts. Should invoke [onSuccess](send-message-to-multiple-contacts.md) with a list of IDs of the contacts which were successfully sent the message. If the user cancelled sending the message, should invoked [onSuccess](send-message-to-multiple-contacts.md) with null. Should invoke [onError](send-message-to-multiple-contacts.md) when there was an error. diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.chat/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.chat/index.md new file mode 100644 index 000000000..eee8fed16 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.chat/index.md @@ -0,0 +1,9 @@ +//[miniapp](../../index.md)/[com.rakuten.tech.mobile.miniapp.js.chat](index.md) + +# Package com.rakuten.tech.mobile.miniapp.js.chat + +## Types + +| Name | Summary | +|---|---| +| [ChatBridgeDispatcher](-chat-bridge-dispatcher/index.md) | [androidJvm]
interface [ChatBridgeDispatcher](-chat-bridge-dispatcher/index.md)
Functionalities related to Chatting with the contacts. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-app-theme-colors/-host-app-theme-colors.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-app-theme-colors/-host-app-theme-colors.md new file mode 100644 index 000000000..a269f8dfd --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-app-theme-colors/-host-app-theme-colors.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.hostenvironment](../index.md)/[HostAppThemeColors](index.md)/[HostAppThemeColors](-host-app-theme-colors.md) + +# HostAppThemeColors + +[androidJvm]\ +fun [HostAppThemeColors](-host-app-theme-colors.md)(primaryColor: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, secondaryColor: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-app-theme-colors/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-app-theme-colors/index.md new file mode 100644 index 000000000..6b8a7c151 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-app-theme-colors/index.md @@ -0,0 +1,21 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.hostenvironment](../index.md)/[HostAppThemeColors](index.md) + +# HostAppThemeColors + +[androidJvm]\ +data class [HostAppThemeColors](index.md)(primaryColor: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, secondaryColor: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) + +Represents the color theme of the host app. + +## Constructors + +| | | +|---|---| +| [HostAppThemeColors](-host-app-theme-colors.md) | [androidJvm]
fun [HostAppThemeColors](-host-app-theme-colors.md)(primaryColor: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, secondaryColor: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) | + +## Properties + +| Name | Summary | +|---|---| +| [primaryColor](primary-color.md) | [androidJvm]
var [primaryColor](primary-color.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?
The primary color of the host app. | +| [secondaryColor](secondary-color.md) | [androidJvm]
val [secondaryColor](secondary-color.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?
The secondary color of the host app. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-app-theme-colors/primary-color.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-app-theme-colors/primary-color.md new file mode 100644 index 000000000..a45e9fa9c --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-app-theme-colors/primary-color.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.hostenvironment](../index.md)/[HostAppThemeColors](index.md)/[primaryColor](primary-color.md) + +# primaryColor + +[androidJvm]\ +var [primaryColor](primary-color.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-app-theme-colors/secondary-color.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-app-theme-colors/secondary-color.md new file mode 100644 index 000000000..c9de1e9a9 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-app-theme-colors/secondary-color.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.hostenvironment](../index.md)/[HostAppThemeColors](index.md)/[secondaryColor](secondary-color.md) + +# secondaryColor + +[androidJvm]\ +val [secondaryColor](secondary-color.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info-error/-companion/custom.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info-error/-companion/custom.md new file mode 100644 index 000000000..d923c949e --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info-error/-companion/custom.md @@ -0,0 +1,8 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.hostenvironment](../../index.md)/[HostEnvironmentInfoError](../index.md)/[Companion](index.md)/[custom](custom.md) + +# custom + +[androidJvm]\ +fun [custom](custom.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [HostEnvironmentInfoError](../index.md) + +send custom error message from host app. diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info-error/-companion/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info-error/-companion/index.md new file mode 100644 index 000000000..9cdac07f8 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info-error/-companion/index.md @@ -0,0 +1,12 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.hostenvironment](../../index.md)/[HostEnvironmentInfoError](../index.md)/[Companion](index.md) + +# Companion + +[androidJvm]\ +object [Companion](index.md) + +## Functions + +| Name | Summary | +|---|---| +| [custom](custom.md) | [androidJvm]
fun [custom](custom.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [HostEnvironmentInfoError](../index.md)
send custom error message from host app. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info-error/-host-environment-info-error.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info-error/-host-environment-info-error.md new file mode 100644 index 000000000..ea33819d3 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info-error/-host-environment-info-error.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.hostenvironment](../index.md)/[HostEnvironmentInfoError](index.md)/[HostEnvironmentInfoError](-host-environment-info-error.md) + +# HostEnvironmentInfoError + +[androidJvm]\ +fun [HostEnvironmentInfoError](-host-environment-info-error.md)(type: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info-error/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info-error/index.md new file mode 100644 index 000000000..0716101fa --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info-error/index.md @@ -0,0 +1,27 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.hostenvironment](../index.md)/[HostEnvironmentInfoError](index.md) + +# HostEnvironmentInfoError + +[androidJvm]\ +class [HostEnvironmentInfoError](index.md)(type: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) : [MiniAppBridgeError](../../com.rakuten.tech.mobile.miniapp.errors/-mini-app-bridge-error/index.md) + +A class to provide the custom errors specific for host environment info. + +## Constructors + +| | | +|---|---| +| [HostEnvironmentInfoError](-host-environment-info-error.md) | [androidJvm]
fun [HostEnvironmentInfoError](-host-environment-info-error.md)(type: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null) | + +## Types + +| Name | Summary | +|---|---| +| [Companion](-companion/index.md) | [androidJvm]
object [Companion](-companion/index.md) | + +## Properties + +| Name | Summary | +|---|---| +| [message](message.md) | [androidJvm]
val [message](message.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null | +| [type](type.md) | [androidJvm]
val [type](type.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info-error/message.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info-error/message.md new file mode 100644 index 000000000..b0ad64bce --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info-error/message.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.hostenvironment](../index.md)/[HostEnvironmentInfoError](index.md)/[message](message.md) + +# message + +[androidJvm]\ +val [message](message.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info-error/type.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info-error/type.md new file mode 100644 index 000000000..e9ba85812 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info-error/type.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.hostenvironment](../index.md)/[HostEnvironmentInfoError](index.md)/[type](type.md) + +# type + +[androidJvm]\ +val [type](type.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info/-host-environment-info.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info/-host-environment-info.md new file mode 100644 index 000000000..dbe5ddf20 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info/-host-environment-info.md @@ -0,0 +1,8 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.hostenvironment](../index.md)/[HostEnvironmentInfo](index.md)/[HostEnvironmentInfo](-host-environment-info.md) + +# HostEnvironmentInfo + +[androidJvm]\ +fun [HostEnvironmentInfo](-host-environment-info.md)(activity: [Activity](https://developer.android.com/reference/kotlin/android/app/Activity.html), hostLocale: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) + +fun [HostEnvironmentInfo](-host-environment-info.md)(platformVersion: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), hostVersion: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), sdkVersion: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), hostLocale: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info/host-locale.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info/host-locale.md new file mode 100644 index 000000000..a704bd668 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info/host-locale.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.hostenvironment](../index.md)/[HostEnvironmentInfo](index.md)/[hostLocale](host-locale.md) + +# hostLocale + +[androidJvm]\ +val [hostLocale](host-locale.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info/host-version.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info/host-version.md new file mode 100644 index 000000000..612deeff2 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info/host-version.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.hostenvironment](../index.md)/[HostEnvironmentInfo](index.md)/[hostVersion](host-version.md) + +# hostVersion + +[androidJvm]\ +val [hostVersion](host-version.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info/index.md new file mode 100644 index 000000000..62103bda0 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info/index.md @@ -0,0 +1,24 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.hostenvironment](../index.md)/[HostEnvironmentInfo](index.md) + +# HostEnvironmentInfo + +[androidJvm]\ +data class [HostEnvironmentInfo](index.md)(platformVersion: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), hostVersion: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), sdkVersion: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), hostLocale: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) + +HostEnvironmentInfo object for miniapp. + +## Constructors + +| | | +|---|---| +| [HostEnvironmentInfo](-host-environment-info.md) | [androidJvm]
fun [HostEnvironmentInfo](-host-environment-info.md)(activity: [Activity](https://developer.android.com/reference/kotlin/android/app/Activity.html), hostLocale: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) | +| [HostEnvironmentInfo](-host-environment-info.md) | [androidJvm]
fun [HostEnvironmentInfo](-host-environment-info.md)(platformVersion: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), hostVersion: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), sdkVersion: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), hostLocale: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) | + +## Properties + +| Name | Summary | +|---|---| +| [hostLocale](host-locale.md) | [androidJvm]
val [hostLocale](host-locale.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [hostVersion](host-version.md) | [androidJvm]
val [hostVersion](host-version.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [platformVersion](platform-version.md) | [androidJvm]
val [platformVersion](platform-version.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [sdkVersion](sdk-version.md) | [androidJvm]
val [sdkVersion](sdk-version.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info/platform-version.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info/platform-version.md new file mode 100644 index 000000000..42ec65ed2 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info/platform-version.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.hostenvironment](../index.md)/[HostEnvironmentInfo](index.md)/[platformVersion](platform-version.md) + +# platformVersion + +[androidJvm]\ +val [platformVersion](platform-version.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info/sdk-version.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info/sdk-version.md new file mode 100644 index 000000000..bbfc78d1b --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info/sdk-version.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.hostenvironment](../index.md)/[HostEnvironmentInfo](index.md)/[sdkVersion](sdk-version.md) + +# sdkVersion + +[androidJvm]\ +val [sdkVersion](sdk-version.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/index.md new file mode 100644 index 000000000..7c71fcf20 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/index.md @@ -0,0 +1,11 @@ +//[miniapp](../../index.md)/[com.rakuten.tech.mobile.miniapp.js.hostenvironment](index.md) + +# Package com.rakuten.tech.mobile.miniapp.js.hostenvironment + +## Types + +| Name | Summary | +|---|---| +| [HostAppThemeColors](-host-app-theme-colors/index.md) | [androidJvm]
data class [HostAppThemeColors](-host-app-theme-colors/index.md)(primaryColor: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, secondaryColor: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?)
Represents the color theme of the host app. | +| [HostEnvironmentInfo](-host-environment-info/index.md) | [androidJvm]
data class [HostEnvironmentInfo](-host-environment-info/index.md)(platformVersion: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), hostVersion: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), sdkVersion: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), hostLocale: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html))
HostEnvironmentInfo object for miniapp. | +| [HostEnvironmentInfoError](-host-environment-info-error/index.md) | [androidJvm]
class [HostEnvironmentInfoError](-host-environment-info-error/index.md)(type: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) : [MiniAppBridgeError](../com.rakuten.tech.mobile.miniapp.errors/-mini-app-bridge-error/index.md)
A class to provide the custom errors specific for host environment info. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.universalbridge/-universal-bridge-info/-universal-bridge-info.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.universalbridge/-universal-bridge-info/-universal-bridge-info.md new file mode 100644 index 000000000..21eb1151e --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.universalbridge/-universal-bridge-info/-universal-bridge-info.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.universalbridge](../index.md)/[UniversalBridgeInfo](index.md)/[UniversalBridgeInfo](-universal-bridge-info.md) + +# UniversalBridgeInfo + +[androidJvm]\ +fun [UniversalBridgeInfo](-universal-bridge-info.md)(key: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = "", value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = "", description: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = "") diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.universalbridge/-universal-bridge-info/description.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.universalbridge/-universal-bridge-info/description.md new file mode 100644 index 000000000..c1ca4e2fc --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.universalbridge/-universal-bridge-info/description.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.universalbridge](../index.md)/[UniversalBridgeInfo](index.md)/[description](description.md) + +# description + +[androidJvm]\ +var [description](description.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.universalbridge/-universal-bridge-info/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.universalbridge/-universal-bridge-info/index.md new file mode 100644 index 000000000..50dc8bd5e --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.universalbridge/-universal-bridge-info/index.md @@ -0,0 +1,22 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.universalbridge](../index.md)/[UniversalBridgeInfo](index.md) + +# UniversalBridgeInfo + +[androidJvm]\ +data class [UniversalBridgeInfo](index.md)(key: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), description: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) + +An object that is used for sharing Info from Miniapp to Host application. + +## Constructors + +| | | +|---|---| +| [UniversalBridgeInfo](-universal-bridge-info.md) | [androidJvm]
fun [UniversalBridgeInfo](-universal-bridge-info.md)(key: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = "", value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = "", description: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = "") | + +## Properties + +| Name | Summary | +|---|---| +| [description](description.md) | [androidJvm]
var [description](description.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [key](key.md) | [androidJvm]
var [key](key.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [value](value.md) | [androidJvm]
var [value](value.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.universalbridge/-universal-bridge-info/key.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.universalbridge/-universal-bridge-info/key.md new file mode 100644 index 000000000..6c94a8703 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.universalbridge/-universal-bridge-info/key.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.universalbridge](../index.md)/[UniversalBridgeInfo](index.md)/[key](key.md) + +# key + +[androidJvm]\ +var [key](key.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.universalbridge/-universal-bridge-info/value.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.universalbridge/-universal-bridge-info/value.md new file mode 100644 index 000000000..953711401 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.universalbridge/-universal-bridge-info/value.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.universalbridge](../index.md)/[UniversalBridgeInfo](index.md)/[value](value.md) + +# value + +[androidJvm]\ +var [value](value.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.universalbridge/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.universalbridge/index.md new file mode 100644 index 000000000..30a5b6e32 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.universalbridge/index.md @@ -0,0 +1,9 @@ +//[miniapp](../../index.md)/[com.rakuten.tech.mobile.miniapp.js.universalbridge](index.md) + +# Package com.rakuten.tech.mobile.miniapp.js.universalbridge + +## Types + +| Name | Summary | +|---|---| +| [UniversalBridgeInfo](-universal-bridge-info/index.md) | [androidJvm]
data class [UniversalBridgeInfo](-universal-bridge-info/index.md)(key: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), description: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html))
An object that is used for sharing Info from Miniapp to Host application. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-contact/-contact.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-contact/-contact.md new file mode 100644 index 000000000..120d5f152 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-contact/-contact.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.userinfo](../index.md)/[Contact](index.md)/[Contact](-contact.md) + +# Contact + +[androidJvm]\ +fun [Contact](-contact.md)(id: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, email: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, allEmailList: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>?) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-contact/all-email-list.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-contact/all-email-list.md new file mode 100644 index 000000000..f99507130 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-contact/all-email-list.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.userinfo](../index.md)/[Contact](index.md)/[allEmailList](all-email-list.md) + +# allEmailList + +[androidJvm]\ +var [allEmailList](all-email-list.md): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>? diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-contact/email.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-contact/email.md new file mode 100644 index 000000000..ffca23799 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-contact/email.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.userinfo](../index.md)/[Contact](index.md)/[email](email.md) + +# email + +[androidJvm]\ +var [email](email.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-contact/id.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-contact/id.md new file mode 100644 index 000000000..e003be1f7 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-contact/id.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.userinfo](../index.md)/[Contact](index.md)/[id](id.md) + +# id + +[androidJvm]\ +val [id](id.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-contact/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-contact/index.md new file mode 100644 index 000000000..19aec56e9 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-contact/index.md @@ -0,0 +1,23 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.userinfo](../index.md)/[Contact](index.md) + +# Contact + +[androidJvm]\ +data class [Contact](index.md)(id: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, email: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, allEmailList: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>?) + +Contact object for miniapp. + +## Constructors + +| | | +|---|---| +| [Contact](-contact.md) | [androidJvm]
fun [Contact](-contact.md)(id: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, email: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, allEmailList: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>?) | + +## Properties + +| Name | Summary | +|---|---| +| [allEmailList](all-email-list.md) | [androidJvm]
var [allEmailList](all-email-list.md): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>? | +| [email](email.md) | [androidJvm]
var [email](email.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? | +| [id](id.md) | [androidJvm]
val [id](id.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [name](name.md) | [androidJvm]
var [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-contact/name.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-contact/name.md new file mode 100644 index 000000000..d8782924a --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-contact/name.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.userinfo](../index.md)/[Contact](index.md)/[name](name.md) + +# name + +[androidJvm]\ +var [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-points/-points.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-points/-points.md new file mode 100644 index 000000000..f1ab3e69a --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-points/-points.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.userinfo](../index.md)/[Points](index.md)/[Points](-points.md) + +# Points + +[androidJvm]\ +fun [Points](-points.md)(standard: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), term: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), cash: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-points/cash.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-points/cash.md new file mode 100644 index 000000000..6bd92c12e --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-points/cash.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.userinfo](../index.md)/[Points](index.md)/[cash](cash.md) + +# cash + +[androidJvm]\ +var [cash](cash.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-points/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-points/index.md new file mode 100644 index 000000000..e98896157 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-points/index.md @@ -0,0 +1,22 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.userinfo](../index.md)/[Points](index.md) + +# Points + +[androidJvm]\ +data class [Points](index.md)(standard: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), term: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), cash: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) + +Points object for miniapp. + +## Constructors + +| | | +|---|---| +| [Points](-points.md) | [androidJvm]
fun [Points](-points.md)(standard: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), term: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), cash: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) | + +## Properties + +| Name | Summary | +|---|---| +| [cash](cash.md) | [androidJvm]
var [cash](cash.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [standard](standard.md) | [androidJvm]
val [standard](standard.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [term](term.md) | [androidJvm]
var [term](term.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-points/standard.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-points/standard.md new file mode 100644 index 000000000..8578290bc --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-points/standard.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.userinfo](../index.md)/[Points](index.md)/[standard](standard.md) + +# standard + +[androidJvm]\ +val [standard](standard.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-points/term.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-points/term.md new file mode 100644 index 000000000..74cab82c2 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-points/term.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.userinfo](../index.md)/[Points](index.md)/[term](term.md) + +# term + +[androidJvm]\ +var [term](term.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-token-data/-token-data.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-token-data/-token-data.md new file mode 100644 index 000000000..1e0b3a8d8 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-token-data/-token-data.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.userinfo](../index.md)/[TokenData](index.md)/[TokenData](-token-data.md) + +# TokenData + +[androidJvm]\ +fun [TokenData](-token-data.md)(token: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), validUntil: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), scopes: [AccessTokenScope](../../com.rakuten.tech.mobile.miniapp.permission/-access-token-scope/index.md) = AccessTokenScope()) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-token-data/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-token-data/index.md new file mode 100644 index 000000000..35e82597f --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-token-data/index.md @@ -0,0 +1,22 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.userinfo](../index.md)/[TokenData](index.md) + +# TokenData + +[androidJvm]\ +data class [TokenData](index.md)(token: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), validUntil: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), scopes: [AccessTokenScope](../../com.rakuten.tech.mobile.miniapp.permission/-access-token-scope/index.md)) + +Access token object for miniapp. + +## Constructors + +| | | +|---|---| +| [TokenData](-token-data.md) | [androidJvm]
fun [TokenData](-token-data.md)(token: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), validUntil: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), scopes: [AccessTokenScope](../../com.rakuten.tech.mobile.miniapp.permission/-access-token-scope/index.md) = AccessTokenScope()) | + +## Properties + +| Name | Summary | +|---|---| +| [scopes](scopes.md) | [androidJvm]
var [scopes](scopes.md): [AccessTokenScope](../../com.rakuten.tech.mobile.miniapp.permission/-access-token-scope/index.md) | +| [token](token.md) | [androidJvm]
val [token](token.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [validUntil](valid-until.md) | [androidJvm]
val [validUntil](valid-until.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-token-data/scopes.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-token-data/scopes.md new file mode 100644 index 000000000..ad161a15b --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-token-data/scopes.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.userinfo](../index.md)/[TokenData](index.md)/[scopes](scopes.md) + +# scopes + +[androidJvm]\ +var [scopes](scopes.md): [AccessTokenScope](../../com.rakuten.tech.mobile.miniapp.permission/-access-token-scope/index.md) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-token-data/token.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-token-data/token.md new file mode 100644 index 000000000..32613edd5 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-token-data/token.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.userinfo](../index.md)/[TokenData](index.md)/[token](token.md) + +# token + +[androidJvm]\ +val [token](token.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-token-data/valid-until.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-token-data/valid-until.md new file mode 100644 index 000000000..2f85c229e --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-token-data/valid-until.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.userinfo](../index.md)/[TokenData](index.md)/[validUntil](valid-until.md) + +# validUntil + +[androidJvm]\ +val [validUntil](valid-until.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-user-info-bridge-dispatcher/get-access-token.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-user-info-bridge-dispatcher/get-access-token.md new file mode 100644 index 000000000..963797ef8 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-user-info-bridge-dispatcher/get-access-token.md @@ -0,0 +1,20 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.userinfo](../index.md)/[UserInfoBridgeDispatcher](index.md)/[getAccessToken](get-access-token.md) + +# getAccessToken + +[androidJvm]\ + +@[JvmName](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-name/index.html)(name = "getAccessToken") + +open fun [getAccessToken](get-access-token.md)(miniAppId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), accessTokenScope: [AccessTokenScope](../../com.rakuten.tech.mobile.miniapp.permission/-access-token-scope/index.md), onSuccess: (tokenData: [TokenData](../-token-data/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), onError: (tokenError: [MiniAppAccessTokenError](../../com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) + +Get access token from host app. + +## Parameters + +androidJvm + +| | | +|---|---| +| accessTokenScope | contains audience and scope for permission validation. | +| onError | contains custom error message send from host app | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-user-info-bridge-dispatcher/get-contacts.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-user-info-bridge-dispatcher/get-contacts.md new file mode 100644 index 000000000..a4384df6b --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-user-info-bridge-dispatcher/get-contacts.md @@ -0,0 +1,8 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.userinfo](../index.md)/[UserInfoBridgeDispatcher](index.md)/[getContacts](get-contacts.md) + +# getContacts + +[androidJvm]\ +open fun [getContacts](get-contacts.md)(onSuccess: (contacts: [ArrayList](https://developer.android.com/reference/kotlin/java/util/ArrayList.html)<[Contact](../-contact/index.md)>) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), onError: (message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) + +Get contacts from host app. You can also throw an [Exception](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html) from this method to pass an error message to the mini app. diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-user-info-bridge-dispatcher/get-points.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-user-info-bridge-dispatcher/get-points.md new file mode 100644 index 000000000..9b83298bb --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-user-info-bridge-dispatcher/get-points.md @@ -0,0 +1,8 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.userinfo](../index.md)/[UserInfoBridgeDispatcher](index.md)/[getPoints](get-points.md) + +# getPoints + +[androidJvm]\ +open fun [getPoints](get-points.md)(onSuccess: (points: [Points](../-points/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), onError: (pointsError: [MiniAppPointsError](../../com.rakuten.tech.mobile.miniapp.errors/-mini-app-points-error/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) + +Get points from host app. You can also throw an [Exception](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html) from this method to pass an error message to the mini app. diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-user-info-bridge-dispatcher/get-profile-photo.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-user-info-bridge-dispatcher/get-profile-photo.md new file mode 100644 index 000000000..5b5075b9f --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-user-info-bridge-dispatcher/get-profile-photo.md @@ -0,0 +1,8 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.userinfo](../index.md)/[UserInfoBridgeDispatcher](index.md)/[getProfilePhoto](get-profile-photo.md) + +# getProfilePhoto + +[androidJvm]\ +open fun [getProfilePhoto](get-profile-photo.md)(onSuccess: (profilePhoto: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), onError: (message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) + +Get profile photo url from host app. You can also throw an [Exception](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html) from this method to pass an error message to the mini app. diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-user-info-bridge-dispatcher/get-user-name.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-user-info-bridge-dispatcher/get-user-name.md new file mode 100644 index 000000000..82c0b9e73 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-user-info-bridge-dispatcher/get-user-name.md @@ -0,0 +1,8 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.userinfo](../index.md)/[UserInfoBridgeDispatcher](index.md)/[getUserName](get-user-name.md) + +# getUserName + +[androidJvm]\ +open fun [getUserName](get-user-name.md)(onSuccess: (userName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), onError: (message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) + +Get user name from host app. You can also throw an [Exception](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html) from this method to pass an error message to the mini app. diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-user-info-bridge-dispatcher/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-user-info-bridge-dispatcher/index.md new file mode 100644 index 000000000..b3b6983c0 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-user-info-bridge-dispatcher/index.md @@ -0,0 +1,18 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js.userinfo](../index.md)/[UserInfoBridgeDispatcher](index.md) + +# UserInfoBridgeDispatcher + +[androidJvm]\ +interface [UserInfoBridgeDispatcher](index.md) + +A class to provide the interfaces for getting user info e.g. user-name, profile-photo etc. + +## Functions + +| Name | Summary | +|---|---| +| [getAccessToken](get-access-token.md) | [androidJvm]
@[JvmName](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-name/index.html)(name = "getAccessToken")
open fun [getAccessToken](get-access-token.md)(miniAppId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), accessTokenScope: [AccessTokenScope](../../com.rakuten.tech.mobile.miniapp.permission/-access-token-scope/index.md), onSuccess: (tokenData: [TokenData](../-token-data/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), onError: (tokenError: [MiniAppAccessTokenError](../../com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
Get access token from host app. | +| [getContacts](get-contacts.md) | [androidJvm]
open fun [getContacts](get-contacts.md)(onSuccess: (contacts: [ArrayList](https://developer.android.com/reference/kotlin/java/util/ArrayList.html)<[Contact](../-contact/index.md)>) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), onError: (message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
Get contacts from host app. You can also throw an [Exception](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html) from this method to pass an error message to the mini app. | +| [getPoints](get-points.md) | [androidJvm]
open fun [getPoints](get-points.md)(onSuccess: (points: [Points](../-points/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), onError: (pointsError: [MiniAppPointsError](../../com.rakuten.tech.mobile.miniapp.errors/-mini-app-points-error/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
Get points from host app. You can also throw an [Exception](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html) from this method to pass an error message to the mini app. | +| [getProfilePhoto](get-profile-photo.md) | [androidJvm]
open fun [getProfilePhoto](get-profile-photo.md)(onSuccess: (profilePhoto: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), onError: (message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
Get profile photo url from host app. You can also throw an [Exception](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html) from this method to pass an error message to the mini app. | +| [getUserName](get-user-name.md) | [androidJvm]
open fun [getUserName](get-user-name.md)(onSuccess: (userName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), onError: (message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
Get user name from host app. You can also throw an [Exception](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html) from this method to pass an error message to the mini app. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/index.md new file mode 100644 index 000000000..1022a3491 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/index.md @@ -0,0 +1,12 @@ +//[miniapp](../../index.md)/[com.rakuten.tech.mobile.miniapp.js.userinfo](index.md) + +# Package com.rakuten.tech.mobile.miniapp.js.userinfo + +## Types + +| Name | Summary | +|---|---| +| [Contact](-contact/index.md) | [androidJvm]
data class [Contact](-contact/index.md)(id: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, email: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, allEmailList: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>?)
Contact object for miniapp. | +| [Points](-points/index.md) | [androidJvm]
data class [Points](-points/index.md)(standard: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), term: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), cash: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
Points object for miniapp. | +| [TokenData](-token-data/index.md) | [androidJvm]
data class [TokenData](-token-data/index.md)(token: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), validUntil: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), scopes: [AccessTokenScope](../com.rakuten.tech.mobile.miniapp.permission/-access-token-scope/index.md))
Access token object for miniapp. | +| [UserInfoBridgeDispatcher](-user-info-bridge-dispatcher/index.md) | [androidJvm]
interface [UserInfoBridgeDispatcher](-user-info-bridge-dispatcher/index.md)
A class to provide the interfaces for getting user info e.g. user-name, profile-photo etc. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-message-to-contact/-message-to-contact.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-message-to-contact/-message-to-contact.md new file mode 100644 index 000000000..de9eee5e2 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-message-to-contact/-message-to-contact.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js](../index.md)/[MessageToContact](index.md)/[MessageToContact](-message-to-contact.md) + +# MessageToContact + +[androidJvm]\ +fun [MessageToContact](-message-to-contact.md)(image: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), text: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), caption: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), action: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), bannerMessage: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-message-to-contact/action.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-message-to-contact/action.md new file mode 100644 index 000000000..11cee6ae0 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-message-to-contact/action.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js](../index.md)/[MessageToContact](index.md)/[action](action.md) + +# action + +[androidJvm]\ +val [action](action.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-message-to-contact/banner-message.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-message-to-contact/banner-message.md new file mode 100644 index 000000000..b26ca107a --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-message-to-contact/banner-message.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js](../index.md)/[MessageToContact](index.md)/[bannerMessage](banner-message.md) + +# bannerMessage + +[androidJvm]\ +val [bannerMessage](banner-message.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-message-to-contact/caption.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-message-to-contact/caption.md new file mode 100644 index 000000000..14b11c773 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-message-to-contact/caption.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js](../index.md)/[MessageToContact](index.md)/[caption](caption.md) + +# caption + +[androidJvm]\ +val [caption](caption.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-message-to-contact/image.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-message-to-contact/image.md new file mode 100644 index 000000000..7018b1ea4 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-message-to-contact/image.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js](../index.md)/[MessageToContact](index.md)/[image](image.md) + +# image + +[androidJvm]\ +val [image](image.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-message-to-contact/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-message-to-contact/index.md new file mode 100644 index 000000000..759e7677d --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-message-to-contact/index.md @@ -0,0 +1,25 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js](../index.md)/[MessageToContact](index.md) + +# MessageToContact + +[androidJvm]\ +data class [MessageToContact](index.md)(image: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), text: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), caption: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), action: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), bannerMessage: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) + +An object to prepare the message for sending to contacts. + +## Constructors + +| | | +|---|---| +| [MessageToContact](-message-to-contact.md) | [androidJvm]
fun [MessageToContact](-message-to-contact.md)(image: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), text: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), caption: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), action: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), bannerMessage: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null) | + +## Properties + +| Name | Summary | +|---|---| +| [action](action.md) | [androidJvm]
val [action](action.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [bannerMessage](banner-message.md) | [androidJvm]
val [bannerMessage](banner-message.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null | +| [caption](caption.md) | [androidJvm]
val [caption](caption.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [image](image.md) | [androidJvm]
val [image](image.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [isEmpty](is-empty.md) | [androidJvm]
val [isEmpty](is-empty.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Returns true when all the properties are empty, otherwise returns false. | +| [text](text.md) | [androidJvm]
val [text](text.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-message-to-contact/is-empty.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-message-to-contact/is-empty.md new file mode 100644 index 000000000..f1a18510e --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-message-to-contact/is-empty.md @@ -0,0 +1,8 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js](../index.md)/[MessageToContact](index.md)/[isEmpty](is-empty.md) + +# isEmpty + +[androidJvm]\ +val [isEmpty](is-empty.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Returns true when all the properties are empty, otherwise returns false. diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-message-to-contact/text.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-message-to-contact/text.md new file mode 100644 index 000000000..b50ee1529 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-message-to-contact/text.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js](../index.md)/[MessageToContact](index.md)/[text](text.md) + +# text + +[androidJvm]\ +val [text](text.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/-mini-app-message-bridge.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/-mini-app-message-bridge.md new file mode 100644 index 000000000..fbf7f7f92 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/-mini-app-message-bridge.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js](../index.md)/[MiniAppMessageBridge](index.md)/[MiniAppMessageBridge](-mini-app-message-bridge.md) + +# MiniAppMessageBridge + +[androidJvm]\ +fun [MiniAppMessageBridge](-mini-app-message-bridge.md)() diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/allow-screen-orientation.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/allow-screen-orientation.md new file mode 100644 index 000000000..db6348656 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/allow-screen-orientation.md @@ -0,0 +1,8 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js](../index.md)/[MiniAppMessageBridge](index.md)/[allowScreenOrientation](allow-screen-orientation.md) + +# allowScreenOrientation + +[androidJvm]\ +fun [allowScreenOrientation](allow-screen-orientation.md)(isAllowed: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +Allow miniapp to change screen orientation. The default setting is false. diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/did-receive-m-a-analytics.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/did-receive-m-a-analytics.md new file mode 100644 index 000000000..eae6cf26d --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/did-receive-m-a-analytics.md @@ -0,0 +1,16 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js](../index.md)/[MiniAppMessageBridge](index.md)/[didReceiveMAAnalytics](did-receive-m-a-analytics.md) + +# didReceiveMAAnalytics + +[androidJvm]\ +open fun [didReceiveMAAnalytics](did-receive-m-a-analytics.md)(analyticsInfo: [MAAnalyticsInfo](../../com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/index.md), onSuccess: (message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), onError: (message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) + +handle analytics from MiniApp. + +## Parameters + +androidJvm + +| | | +|---|---| +| analyticsInfo | that is sent from the MiniApp. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/dispatch-native-event.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/dispatch-native-event.md new file mode 100644 index 000000000..8930a4858 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/dispatch-native-event.md @@ -0,0 +1,8 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js](../index.md)/[MiniAppMessageBridge](index.md)/[dispatchNativeEvent](dispatch-native-event.md) + +# dispatchNativeEvent + +[androidJvm]\ +fun [dispatchNativeEvent](dispatch-native-event.md)(eventType: [NativeEventType](../-native-event-type/index.md), value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = "") + +Dispatch Native events to miniapp. diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/get-host-app-theme-colors.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/get-host-app-theme-colors.md new file mode 100644 index 000000000..2b7e458f1 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/get-host-app-theme-colors.md @@ -0,0 +1,8 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js](../index.md)/[MiniAppMessageBridge](index.md)/[getHostAppThemeColors](get-host-app-theme-colors.md) + +# getHostAppThemeColors + +[androidJvm]\ +open fun [getHostAppThemeColors](get-host-app-theme-colors.md)(onSuccess: (themeColor: [HostAppThemeColors](../../com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-app-theme-colors/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), onError: (message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) + +Interface that should be implemented to return theme colors that uniquely identifies a host. diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/get-host-environment-info.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/get-host-environment-info.md new file mode 100644 index 000000000..5be007507 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/get-host-environment-info.md @@ -0,0 +1,8 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js](../index.md)/[MiniAppMessageBridge](index.md)/[getHostEnvironmentInfo](get-host-environment-info.md) + +# getHostEnvironmentInfo + +[androidJvm]\ +open fun [getHostEnvironmentInfo](get-host-environment-info.md)(onSuccess: (info: [HostEnvironmentInfo](../../com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), onError: (infoError: [HostEnvironmentInfoError](../../com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info-error/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) + +Get environment info from host app. You can also throw an [Exception](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html) from this method to pass an error message to the mini app. diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/get-is-dark-mode.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/get-is-dark-mode.md new file mode 100644 index 000000000..22d765904 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/get-is-dark-mode.md @@ -0,0 +1,8 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js](../index.md)/[MiniAppMessageBridge](index.md)/[getIsDarkMode](get-is-dark-mode.md) + +# getIsDarkMode + +[androidJvm]\ +open fun [getIsDarkMode](get-is-dark-mode.md)(onSuccess: (isDarkMode: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), onError: (message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) + +Get dark mode info from host app. You can also throw an [Exception](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html) from this method to pass an error message to the mini app. diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/get-mauid.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/get-mauid.md new file mode 100644 index 000000000..de97eb193 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/get-mauid.md @@ -0,0 +1,8 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js](../index.md)/[MiniAppMessageBridge](index.md)/[getMauid](get-mauid.md) + +# getMauid + +[androidJvm]\ +open fun [getMauid](get-mauid.md)(onSuccess: (mauId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), onError: (message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) + +Interface that should be implemented to return alphanumeric string that uniquely identifies a device. diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/get-messaging-unique-id.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/get-messaging-unique-id.md new file mode 100644 index 000000000..cce0d4f7a --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/get-messaging-unique-id.md @@ -0,0 +1,8 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js](../index.md)/[MiniAppMessageBridge](index.md)/[getMessagingUniqueId](get-messaging-unique-id.md) + +# getMessagingUniqueId + +[androidJvm]\ +open fun [getMessagingUniqueId](get-messaging-unique-id.md)(onSuccess: (uniqueId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), onError: (message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) + +Interface that should be implemented to return alphanumeric string that uniquely identifies a device. diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/get-unique-id.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/get-unique-id.md new file mode 100644 index 000000000..db90257da --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/get-unique-id.md @@ -0,0 +1,8 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js](../index.md)/[MiniAppMessageBridge](index.md)/[getUniqueId](get-unique-id.md) + +# getUniqueId + +[androidJvm]\ +~~open~~ ~~fun~~ [~~getUniqueId~~](get-unique-id.md)~~(~~~~onSuccess~~~~:~~ (uniqueId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)~~,~~ ~~onError~~~~:~~ (message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)~~)~~ + +Get provided id of mini app for any purpose. diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/index.md new file mode 100644 index 000000000..3ffcafb70 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/index.md @@ -0,0 +1,41 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js](../index.md)/[MiniAppMessageBridge](index.md) + +# MiniAppMessageBridge + +[androidJvm]\ +open class [MiniAppMessageBridge](index.md) + +Bridge interface for communicating with mini app. + +## Constructors + +| | | +|---|---| +| [MiniAppMessageBridge](-mini-app-message-bridge.md) | [androidJvm]
fun [MiniAppMessageBridge](-mini-app-message-bridge.md)() | + +## Functions + +| Name | Summary | +|---|---| +| [allowScreenOrientation](allow-screen-orientation.md) | [androidJvm]
fun [allowScreenOrientation](allow-screen-orientation.md)(isAllowed: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Allow miniapp to change screen orientation. The default setting is false. | +| [didReceiveMAAnalytics](did-receive-m-a-analytics.md) | [androidJvm]
open fun [didReceiveMAAnalytics](did-receive-m-a-analytics.md)(analyticsInfo: [MAAnalyticsInfo](../../com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/index.md), onSuccess: (message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), onError: (message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
handle analytics from MiniApp. | +| [dispatchNativeEvent](dispatch-native-event.md) | [androidJvm]
fun [dispatchNativeEvent](dispatch-native-event.md)(eventType: [NativeEventType](../-native-event-type/index.md), value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = "")
Dispatch Native events to miniapp. | +| [getHostAppThemeColors](get-host-app-theme-colors.md) | [androidJvm]
open fun [getHostAppThemeColors](get-host-app-theme-colors.md)(onSuccess: (themeColor: [HostAppThemeColors](../../com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-app-theme-colors/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), onError: (message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
Interface that should be implemented to return theme colors that uniquely identifies a host. | +| [getHostEnvironmentInfo](get-host-environment-info.md) | [androidJvm]
open fun [getHostEnvironmentInfo](get-host-environment-info.md)(onSuccess: (info: [HostEnvironmentInfo](../../com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), onError: (infoError: [HostEnvironmentInfoError](../../com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info-error/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
Get environment info from host app. You can also throw an [Exception](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html) from this method to pass an error message to the mini app. | +| [getIsDarkMode](get-is-dark-mode.md) | [androidJvm]
open fun [getIsDarkMode](get-is-dark-mode.md)(onSuccess: (isDarkMode: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), onError: (message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
Get dark mode info from host app. You can also throw an [Exception](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html) from this method to pass an error message to the mini app. | +| [getMauid](get-mauid.md) | [androidJvm]
open fun [getMauid](get-mauid.md)(onSuccess: (mauId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), onError: (message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
Interface that should be implemented to return alphanumeric string that uniquely identifies a device. | +| [getMessagingUniqueId](get-messaging-unique-id.md) | [androidJvm]
open fun [getMessagingUniqueId](get-messaging-unique-id.md)(onSuccess: (uniqueId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), onError: (message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
Interface that should be implemented to return alphanumeric string that uniquely identifies a device. | +| [getUniqueId](get-unique-id.md) | [androidJvm]
~~open~~ ~~fun~~ [~~getUniqueId~~](get-unique-id.md)~~(~~~~onSuccess~~~~:~~ (uniqueId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)~~,~~ ~~onError~~~~:~~ (message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)~~)~~
Get provided id of mini app for any purpose. | +| [miniAppShouldClose](mini-app-should-close.md) | [androidJvm]
fun [miniAppShouldClose](mini-app-should-close.md)(): [MiniAppCloseAlertInfo](../../com.rakuten.tech.mobile.miniapp.closealert/-mini-app-close-alert-info/index.md)?
provide MiniAppCloseAlertInfo to HostApp to show close alert popup. | +| [postMessage](post-message.md) | [androidJvm]
fun [postMessage](post-message.md)(jsonStr: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) | +| [requestCustomPermissions](request-custom-permissions.md) | [androidJvm]
open fun [requestCustomPermissions](request-custom-permissions.md)(permissionsWithDescription: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[Pair](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)<[MiniAppCustomPermissionType](../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/index.md), [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>>, callback: ([List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[Pair](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)<[MiniAppCustomPermissionType](../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/index.md), [MiniAppCustomPermissionResult](../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/index.md)>>) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
Post custom permissions request. | +| [requestDevicePermission](request-device-permission.md) | [androidJvm]
open fun [requestDevicePermission](request-device-permission.md)(miniAppPermissionType: [MiniAppDevicePermissionType](../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-device-permission-type/index.md), callback: (isGranted: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
Post device permission request from external. | +| [sendInfoToHostApp](send-info-to-host-app.md) | [androidJvm]
open fun [sendInfoToHostApp](send-info-to-host-app.md)(universalBridgeInfo: [UniversalBridgeInfo](../../com.rakuten.tech.mobile.miniapp.js.universalbridge/-universal-bridge-info/index.md), onSuccess: (jsonStr: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), onError: (message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
Handle Universal Bridge interface that sends UniversalBridgeInfo from a Miniapp. | +| [sendJsonToHostApp](send-json-to-host-app.md) | [androidJvm]
open fun [sendJsonToHostApp](send-json-to-host-app.md)(jsonStr: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), onSuccess: (jsonStr: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), onError: (message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
handle Universal Bridge that represented as a json from MiniApp. | +| [setAdMobDisplayer](set-ad-mob-displayer.md) | [androidJvm]
fun [setAdMobDisplayer](set-ad-mob-displayer.md)(adDisplayer: MiniAppAdDisplayer)
Set implemented ads displayer. Can use the default provided class from sdk AdMobDisplayer. | +| [setChatBridgeDispatcher](set-chat-bridge-dispatcher.md) | [androidJvm]
fun [setChatBridgeDispatcher](set-chat-bridge-dispatcher.md)(bridgeDispatcher: [ChatBridgeDispatcher](../../com.rakuten.tech.mobile.miniapp.js.chat/-chat-bridge-dispatcher/index.md))
Set implemented chatBridgeDispatcher. Can use the default provided class from sdk [ChatBridgeDispatcher](../../com.rakuten.tech.mobile.miniapp.js.chat/-chat-bridge-dispatcher/index.md). | +| [setInAppPurchaseProvider](set-in-app-purchase-provider.md) | [androidJvm]
fun [setInAppPurchaseProvider](set-in-app-purchase-provider.md)(iapProvider: InAppPurchaseProvider): [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)?
Set implemented InAppPurchaseProvider. Can use the default provided class from sdk InAppPurchaseProvider. | +| [setMiniAppCloseListener](set-mini-app-close-listener.md) | [androidJvm]
fun [setMiniAppCloseListener](set-mini-app-close-listener.md)(callback: (withConfirmationAlert: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
Allow Host app to receive the miniapp close event. | +| [setMiniAppFileDownloader](set-mini-app-file-downloader.md) | [androidJvm]
fun [setMiniAppFileDownloader](set-mini-app-file-downloader.md)(miniAppFileDownloader: [MiniAppFileDownloader](../../com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader/index.md)): [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)?
Set implemented file downloader. Can use the default provided class from sdk [MiniAppFileDownloaderDefault](../../com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader-default/index.md). | +| [setUserInfoBridgeDispatcher](set-user-info-bridge-dispatcher.md) | [androidJvm]
fun [setUserInfoBridgeDispatcher](set-user-info-bridge-dispatcher.md)(bridgeDispatcher: [UserInfoBridgeDispatcher](../../com.rakuten.tech.mobile.miniapp.js.userinfo/-user-info-bridge-dispatcher/index.md))
Set implemented userInfoBridgeDispatcher. Can use the default provided class from sdk [UserInfoBridgeDispatcher](../../com.rakuten.tech.mobile.miniapp.js.userinfo/-user-info-bridge-dispatcher/index.md). | +| [shareContent](share-content.md) | [androidJvm]
open fun [shareContent](share-content.md)(content: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), callback: (isSuccess: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
Share content info ShareInfo. This info is provided by mini app. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/mini-app-should-close.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/mini-app-should-close.md new file mode 100644 index 000000000..7f8715e76 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/mini-app-should-close.md @@ -0,0 +1,8 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js](../index.md)/[MiniAppMessageBridge](index.md)/[miniAppShouldClose](mini-app-should-close.md) + +# miniAppShouldClose + +[androidJvm]\ +fun [miniAppShouldClose](mini-app-should-close.md)(): [MiniAppCloseAlertInfo](../../com.rakuten.tech.mobile.miniapp.closealert/-mini-app-close-alert-info/index.md)? + +provide MiniAppCloseAlertInfo to HostApp to show close alert popup. diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/post-message.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/post-message.md new file mode 100644 index 000000000..04b7f8871 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/post-message.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js](../index.md)/[MiniAppMessageBridge](index.md)/[postMessage](post-message.md) + +# postMessage + +[androidJvm]\ +fun [postMessage](post-message.md)(jsonStr: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/request-custom-permissions.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/request-custom-permissions.md new file mode 100644 index 000000000..d562d56e6 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/request-custom-permissions.md @@ -0,0 +1,17 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js](../index.md)/[MiniAppMessageBridge](index.md)/[requestCustomPermissions](request-custom-permissions.md) + +# requestCustomPermissions + +[androidJvm]\ +open fun [requestCustomPermissions](request-custom-permissions.md)(permissionsWithDescription: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[Pair](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)<[MiniAppCustomPermissionType](../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/index.md), [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>>, callback: ([List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[Pair](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)<[MiniAppCustomPermissionType](../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/index.md), [MiniAppCustomPermissionResult](../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/index.md)>>) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) + +Post custom permissions request. + +## Parameters + +androidJvm + +| | | +|---|---| +| permissionsWithDescription | list of name and descriptions of custom permissions sent from external. | +| callback | to invoke a list of name and grant results of custom permissions sent from hostapp. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/request-device-permission.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/request-device-permission.md new file mode 100644 index 000000000..558207d5c --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/request-device-permission.md @@ -0,0 +1,8 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js](../index.md)/[MiniAppMessageBridge](index.md)/[requestDevicePermission](request-device-permission.md) + +# requestDevicePermission + +[androidJvm]\ +open fun [requestDevicePermission](request-device-permission.md)(miniAppPermissionType: [MiniAppDevicePermissionType](../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-device-permission-type/index.md), callback: (isGranted: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) + +Post device permission request from external. diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/send-info-to-host-app.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/send-info-to-host-app.md new file mode 100644 index 000000000..5853d961d --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/send-info-to-host-app.md @@ -0,0 +1,16 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js](../index.md)/[MiniAppMessageBridge](index.md)/[sendInfoToHostApp](send-info-to-host-app.md) + +# sendInfoToHostApp + +[androidJvm]\ +open fun [sendInfoToHostApp](send-info-to-host-app.md)(universalBridgeInfo: [UniversalBridgeInfo](../../com.rakuten.tech.mobile.miniapp.js.universalbridge/-universal-bridge-info/index.md), onSuccess: (jsonStr: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), onError: (message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) + +Handle Universal Bridge interface that sends UniversalBridgeInfo from a Miniapp. + +## Parameters + +androidJvm + +| | | +|---|---| +| universalBridgeInfo | : UniversalBridgeInfo that is sent from the MiniApp | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/send-json-to-host-app.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/send-json-to-host-app.md new file mode 100644 index 000000000..4510a5cc5 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/send-json-to-host-app.md @@ -0,0 +1,16 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js](../index.md)/[MiniAppMessageBridge](index.md)/[sendJsonToHostApp](send-json-to-host-app.md) + +# sendJsonToHostApp + +[androidJvm]\ +open fun [sendJsonToHostApp](send-json-to-host-app.md)(jsonStr: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), onSuccess: (jsonStr: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), onError: (message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) + +handle Universal Bridge that represented as a json from MiniApp. + +## Parameters + +androidJvm + +| | | +|---|---| +| jsonStr | : JSON/String that is sent from the MiniApp. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/set-ad-mob-displayer.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/set-ad-mob-displayer.md new file mode 100644 index 000000000..d8243d120 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/set-ad-mob-displayer.md @@ -0,0 +1,8 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js](../index.md)/[MiniAppMessageBridge](index.md)/[setAdMobDisplayer](set-ad-mob-displayer.md) + +# setAdMobDisplayer + +[androidJvm]\ +fun [setAdMobDisplayer](set-ad-mob-displayer.md)(adDisplayer: MiniAppAdDisplayer) + +Set implemented ads displayer. Can use the default provided class from sdk AdMobDisplayer. diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/set-chat-bridge-dispatcher.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/set-chat-bridge-dispatcher.md new file mode 100644 index 000000000..732e1261a --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/set-chat-bridge-dispatcher.md @@ -0,0 +1,8 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js](../index.md)/[MiniAppMessageBridge](index.md)/[setChatBridgeDispatcher](set-chat-bridge-dispatcher.md) + +# setChatBridgeDispatcher + +[androidJvm]\ +fun [setChatBridgeDispatcher](set-chat-bridge-dispatcher.md)(bridgeDispatcher: [ChatBridgeDispatcher](../../com.rakuten.tech.mobile.miniapp.js.chat/-chat-bridge-dispatcher/index.md)) + +Set implemented chatBridgeDispatcher. Can use the default provided class from sdk [ChatBridgeDispatcher](../../com.rakuten.tech.mobile.miniapp.js.chat/-chat-bridge-dispatcher/index.md). diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/set-in-app-purchase-provider.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/set-in-app-purchase-provider.md new file mode 100644 index 000000000..91c09266f --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/set-in-app-purchase-provider.md @@ -0,0 +1,8 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js](../index.md)/[MiniAppMessageBridge](index.md)/[setInAppPurchaseProvider](set-in-app-purchase-provider.md) + +# setInAppPurchaseProvider + +[androidJvm]\ +fun [setInAppPurchaseProvider](set-in-app-purchase-provider.md)(iapProvider: InAppPurchaseProvider): [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)? + +Set implemented InAppPurchaseProvider. Can use the default provided class from sdk InAppPurchaseProvider. diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/set-mini-app-close-listener.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/set-mini-app-close-listener.md new file mode 100644 index 000000000..196e15716 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/set-mini-app-close-listener.md @@ -0,0 +1,8 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js](../index.md)/[MiniAppMessageBridge](index.md)/[setMiniAppCloseListener](set-mini-app-close-listener.md) + +# setMiniAppCloseListener + +[androidJvm]\ +fun [setMiniAppCloseListener](set-mini-app-close-listener.md)(callback: (withConfirmationAlert: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) + +Allow Host app to receive the miniapp close event. diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/set-mini-app-file-downloader.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/set-mini-app-file-downloader.md new file mode 100644 index 000000000..3d00fe5f3 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/set-mini-app-file-downloader.md @@ -0,0 +1,8 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js](../index.md)/[MiniAppMessageBridge](index.md)/[setMiniAppFileDownloader](set-mini-app-file-downloader.md) + +# setMiniAppFileDownloader + +[androidJvm]\ +fun [setMiniAppFileDownloader](set-mini-app-file-downloader.md)(miniAppFileDownloader: [MiniAppFileDownloader](../../com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader/index.md)): [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)? + +Set implemented file downloader. Can use the default provided class from sdk [MiniAppFileDownloaderDefault](../../com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader-default/index.md). diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/set-user-info-bridge-dispatcher.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/set-user-info-bridge-dispatcher.md new file mode 100644 index 000000000..89454e3ef --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/set-user-info-bridge-dispatcher.md @@ -0,0 +1,8 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js](../index.md)/[MiniAppMessageBridge](index.md)/[setUserInfoBridgeDispatcher](set-user-info-bridge-dispatcher.md) + +# setUserInfoBridgeDispatcher + +[androidJvm]\ +fun [setUserInfoBridgeDispatcher](set-user-info-bridge-dispatcher.md)(bridgeDispatcher: [UserInfoBridgeDispatcher](../../com.rakuten.tech.mobile.miniapp.js.userinfo/-user-info-bridge-dispatcher/index.md)) + +Set implemented userInfoBridgeDispatcher. Can use the default provided class from sdk [UserInfoBridgeDispatcher](../../com.rakuten.tech.mobile.miniapp.js.userinfo/-user-info-bridge-dispatcher/index.md). diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/share-content.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/share-content.md new file mode 100644 index 000000000..424ec386b --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/share-content.md @@ -0,0 +1,17 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js](../index.md)/[MiniAppMessageBridge](index.md)/[shareContent](share-content.md) + +# shareContent + +[androidJvm]\ +open fun [shareContent](share-content.md)(content: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), callback: (isSuccess: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) + +Share content info ShareInfo. This info is provided by mini app. + +## Parameters + +androidJvm + +| | | +|---|---| +| content | The content property of ShareInfo object. | +| callback | The executed action status should be notified back to mini app. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-native-event-type/-e-x-t-e-r-n-a-l_-w-e-b-v-i-e-w_-c-l-o-s-e/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-native-event-type/-e-x-t-e-r-n-a-l_-w-e-b-v-i-e-w_-c-l-o-s-e/index.md new file mode 100644 index 000000000..a3298027a --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-native-event-type/-e-x-t-e-r-n-a-l_-w-e-b-v-i-e-w_-c-l-o-s-e/index.md @@ -0,0 +1,14 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.js](../../index.md)/[NativeEventType](../index.md)/[EXTERNAL_WEBVIEW_CLOSE](index.md) + +# EXTERNAL_WEBVIEW_CLOSE + +[androidJvm]\ +[EXTERNAL_WEBVIEW_CLOSE](index.md)("miniappwebviewclosed") + +## Properties + +| Name | Summary | +|---|---| +| [name](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739) | [androidJvm]
val [name](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739) | [androidJvm]
val [ordinal](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [value](../value.md) | [androidJvm]
val [value](../value.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-native-event-type/-m-i-n-i-a-p-p_-o-n_-p-a-u-s-e/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-native-event-type/-m-i-n-i-a-p-p_-o-n_-p-a-u-s-e/index.md new file mode 100644 index 000000000..c969b0cb6 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-native-event-type/-m-i-n-i-a-p-p_-o-n_-p-a-u-s-e/index.md @@ -0,0 +1,14 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.js](../../index.md)/[NativeEventType](../index.md)/[MINIAPP_ON_PAUSE](index.md) + +# MINIAPP_ON_PAUSE + +[androidJvm]\ +[MINIAPP_ON_PAUSE](index.md)("miniapppause") + +## Properties + +| Name | Summary | +|---|---| +| [name](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739) | [androidJvm]
val [name](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739) | [androidJvm]
val [ordinal](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [value](../value.md) | [androidJvm]
val [value](../value.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-native-event-type/-m-i-n-i-a-p-p_-o-n_-r-e-s-u-m-e/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-native-event-type/-m-i-n-i-a-p-p_-o-n_-r-e-s-u-m-e/index.md new file mode 100644 index 000000000..6b824b9c1 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-native-event-type/-m-i-n-i-a-p-p_-o-n_-r-e-s-u-m-e/index.md @@ -0,0 +1,14 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.js](../../index.md)/[NativeEventType](../index.md)/[MINIAPP_ON_RESUME](index.md) + +# MINIAPP_ON_RESUME + +[androidJvm]\ +[MINIAPP_ON_RESUME](index.md)("miniappresume") + +## Properties + +| Name | Summary | +|---|---| +| [name](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739) | [androidJvm]
val [name](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739) | [androidJvm]
val [ordinal](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [value](../value.md) | [androidJvm]
val [value](../value.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-native-event-type/-m-i-n-i-a-p-p_-r-e-c-e-i-v-e_-j-s-o-n_-i-n-f-o/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-native-event-type/-m-i-n-i-a-p-p_-r-e-c-e-i-v-e_-j-s-o-n_-i-n-f-o/index.md new file mode 100644 index 000000000..137047dcc --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-native-event-type/-m-i-n-i-a-p-p_-r-e-c-e-i-v-e_-j-s-o-n_-i-n-f-o/index.md @@ -0,0 +1,14 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.js](../../index.md)/[NativeEventType](../index.md)/[MINIAPP_RECEIVE_JSON_INFO](index.md) + +# MINIAPP_RECEIVE_JSON_INFO + +[androidJvm]\ +[MINIAPP_RECEIVE_JSON_INFO](index.md)("miniappreceivejsoninfo") + +## Properties + +| Name | Summary | +|---|---| +| [name](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739) | [androidJvm]
val [name](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739) | [androidJvm]
val [ordinal](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [value](../value.md) | [androidJvm]
val [value](../value.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-native-event-type/-m-i-n-i-a-p-p_-s-e-c-u-r-e_-s-t-o-r-a-g-e_-l-o-a-d_-e-r-r-o-r/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-native-event-type/-m-i-n-i-a-p-p_-s-e-c-u-r-e_-s-t-o-r-a-g-e_-l-o-a-d_-e-r-r-o-r/index.md new file mode 100644 index 000000000..bb5ab9b17 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-native-event-type/-m-i-n-i-a-p-p_-s-e-c-u-r-e_-s-t-o-r-a-g-e_-l-o-a-d_-e-r-r-o-r/index.md @@ -0,0 +1,14 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.js](../../index.md)/[NativeEventType](../index.md)/[MINIAPP_SECURE_STORAGE_LOAD_ERROR](index.md) + +# MINIAPP_SECURE_STORAGE_LOAD_ERROR + +[androidJvm]\ +[MINIAPP_SECURE_STORAGE_LOAD_ERROR](index.md)("miniappsecurestorageloaderror") + +## Properties + +| Name | Summary | +|---|---| +| [name](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739) | [androidJvm]
val [name](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739) | [androidJvm]
val [ordinal](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [value](../value.md) | [androidJvm]
val [value](../value.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-native-event-type/-m-i-n-i-a-p-p_-s-e-c-u-r-e_-s-t-o-r-a-g-e_-r-e-a-d-y/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-native-event-type/-m-i-n-i-a-p-p_-s-e-c-u-r-e_-s-t-o-r-a-g-e_-r-e-a-d-y/index.md new file mode 100644 index 000000000..6468b3c38 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-native-event-type/-m-i-n-i-a-p-p_-s-e-c-u-r-e_-s-t-o-r-a-g-e_-r-e-a-d-y/index.md @@ -0,0 +1,14 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.js](../../index.md)/[NativeEventType](../index.md)/[MINIAPP_SECURE_STORAGE_READY](index.md) + +# MINIAPP_SECURE_STORAGE_READY + +[androidJvm]\ +[MINIAPP_SECURE_STORAGE_READY](index.md)("miniappsecurestorageready") + +## Properties + +| Name | Summary | +|---|---| +| [name](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739) | [androidJvm]
val [name](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739) | [androidJvm]
val [ordinal](../../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [value](../value.md) | [androidJvm]
val [value](../value.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-native-event-type/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-native-event-type/index.md new file mode 100644 index 000000000..5d65944f6 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-native-event-type/index.md @@ -0,0 +1,27 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js](../index.md)/[NativeEventType](index.md) + +# NativeEventType + +[androidJvm]\ +enum [NativeEventType](index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[NativeEventType](index.md)> + +Types of native events can be dispatched to miniapp. + +## Entries + +| | | +|---|---| +| [MINIAPP_RECEIVE_JSON_INFO](-m-i-n-i-a-p-p_-r-e-c-e-i-v-e_-j-s-o-n_-i-n-f-o/index.md) | [androidJvm]
[MINIAPP_RECEIVE_JSON_INFO](-m-i-n-i-a-p-p_-r-e-c-e-i-v-e_-j-s-o-n_-i-n-f-o/index.md)("miniappreceivejsoninfo") | +| [MINIAPP_SECURE_STORAGE_LOAD_ERROR](-m-i-n-i-a-p-p_-s-e-c-u-r-e_-s-t-o-r-a-g-e_-l-o-a-d_-e-r-r-o-r/index.md) | [androidJvm]
[MINIAPP_SECURE_STORAGE_LOAD_ERROR](-m-i-n-i-a-p-p_-s-e-c-u-r-e_-s-t-o-r-a-g-e_-l-o-a-d_-e-r-r-o-r/index.md)("miniappsecurestorageloaderror") | +| [MINIAPP_SECURE_STORAGE_READY](-m-i-n-i-a-p-p_-s-e-c-u-r-e_-s-t-o-r-a-g-e_-r-e-a-d-y/index.md) | [androidJvm]
[MINIAPP_SECURE_STORAGE_READY](-m-i-n-i-a-p-p_-s-e-c-u-r-e_-s-t-o-r-a-g-e_-r-e-a-d-y/index.md)("miniappsecurestorageready") | +| [MINIAPP_ON_RESUME](-m-i-n-i-a-p-p_-o-n_-r-e-s-u-m-e/index.md) | [androidJvm]
[MINIAPP_ON_RESUME](-m-i-n-i-a-p-p_-o-n_-r-e-s-u-m-e/index.md)("miniappresume") | +| [MINIAPP_ON_PAUSE](-m-i-n-i-a-p-p_-o-n_-p-a-u-s-e/index.md) | [androidJvm]
[MINIAPP_ON_PAUSE](-m-i-n-i-a-p-p_-o-n_-p-a-u-s-e/index.md)("miniapppause") | +| [EXTERNAL_WEBVIEW_CLOSE](-e-x-t-e-r-n-a-l_-w-e-b-v-i-e-w_-c-l-o-s-e/index.md) | [androidJvm]
[EXTERNAL_WEBVIEW_CLOSE](-e-x-t-e-r-n-a-l_-w-e-b-v-i-e-w_-c-l-o-s-e/index.md)("miniappwebviewclosed") | + +## Properties + +| Name | Summary | +|---|---| +| [name](../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739) | [androidJvm]
val [name](../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739) | [androidJvm]
val [ordinal](../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [value](value.md) | [androidJvm]
val [value](value.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-native-event-type/value.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-native-event-type/value.md new file mode 100644 index 000000000..abad43edc --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/-native-event-type/value.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.js](../index.md)/[NativeEventType](index.md)/[value](value.md) + +# value + +[androidJvm]\ +val [value](value.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/index.md new file mode 100644 index 000000000..cb1600d17 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.js/index.md @@ -0,0 +1,11 @@ +//[miniapp](../../index.md)/[com.rakuten.tech.mobile.miniapp.js](index.md) + +# Package com.rakuten.tech.mobile.miniapp.js + +## Types + +| Name | Summary | +|---|---| +| [MessageToContact](-message-to-contact/index.md) | [androidJvm]
data class [MessageToContact](-message-to-contact/index.md)(image: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), text: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), caption: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), action: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), bannerMessage: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?)
An object to prepare the message for sending to contacts. | +| [MiniAppMessageBridge](-mini-app-message-bridge/index.md) | [androidJvm]
open class [MiniAppMessageBridge](-mini-app-message-bridge/index.md)
Bridge interface for communicating with mini app. | +| [NativeEventType](-native-event-type/index.md) | [androidJvm]
enum [NativeEventType](-native-event-type/index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[NativeEventType](-native-event-type/index.md)>
Types of native events can be dispatched to miniapp. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-external-result-handler/-external-result-handler.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-external-result-handler/-external-result-handler.md new file mode 100644 index 000000000..33975bf6d --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-external-result-handler/-external-result-handler.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.navigator](../index.md)/[ExternalResultHandler](index.md)/[ExternalResultHandler](-external-result-handler.md) + +# ExternalResultHandler + +[androidJvm]\ +fun [ExternalResultHandler](-external-result-handler.md)() diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-external-result-handler/emit-result.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-external-result-handler/emit-result.md new file mode 100644 index 000000000..0b81dadbc --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-external-result-handler/emit-result.md @@ -0,0 +1,37 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.navigator](../index.md)/[ExternalResultHandler](index.md)/[emitResult](emit-result.md) + +# emitResult + +[androidJvm]\ +fun [emitResult](emit-result.md)(url: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) + +Notify the result to mini app view. + +## Parameters + +androidJvm + +| | | +|---|---| +| url | Return the current loading url to mini app view. | + +[androidJvm]\ +fun [emitResult](emit-result.md)(intent: [Intent](https://developer.android.com/reference/kotlin/android/content/Intent.html)) + +Notify the result to mini app view. Use this when go with auto close Activity approach. + +## See also + +androidJvm + +| | | +|---|---| +| [com.rakuten.tech.mobile.miniapp.navigator.MiniAppExternalUrlLoader](../-mini-app-external-url-loader/index.md) | . | + +## Parameters + +androidJvm + +| | | +|---|---| +| intent | The result intent from closing Activity. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-external-result-handler/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-external-result-handler/index.md new file mode 100644 index 000000000..e3f21537e --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-external-result-handler/index.md @@ -0,0 +1,20 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.navigator](../index.md)/[ExternalResultHandler](index.md) + +# ExternalResultHandler + +[androidJvm]\ +class [ExternalResultHandler](index.md) + +The url transmitter from external factors to mini app view. + +## Constructors + +| | | +|---|---| +| [ExternalResultHandler](-external-result-handler.md) | [androidJvm]
fun [ExternalResultHandler](-external-result-handler.md)() | + +## Functions + +| Name | Summary | +|---|---| +| [emitResult](emit-result.md) | [androidJvm]
fun [emitResult](emit-result.md)(intent: [Intent](https://developer.android.com/reference/kotlin/android/content/Intent.html))
Notify the result to mini app view. Use this when go with auto close Activity approach.
[androidJvm]
fun [emitResult](emit-result.md)(url: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html))
Notify the result to mini app view. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-download-navigator/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-download-navigator/index.md new file mode 100644 index 000000000..db3f1072d --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-download-navigator/index.md @@ -0,0 +1,15 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.navigator](../index.md)/[MiniAppDownloadNavigator](index.md) + +# MiniAppDownloadNavigator + +[androidJvm]\ +interface [MiniAppDownloadNavigator](index.md) : [MiniAppNavigator](../-mini-app-navigator/index.md) + +File download controller for mini app view. This interface can optionally be used with your MiniAppNavigator if you wish to intercept file download requests from the mini app. If you do not use this interface, then default handling will be used for file download requests. + +## Functions + +| Name | Summary | +|---|---| +| [onFileDownloadStart](on-file-download-start.md) | [androidJvm]
abstract fun [onFileDownloadStart](on-file-download-start.md)(url: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), userAgent: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), contentDisposition: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), mimetype: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), contentLength: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
Notify the host application that a file should be downloaded. | +| [openExternalUrl](../-mini-app-navigator/open-external-url.md) | [androidJvm]
abstract fun [openExternalUrl](../-mini-app-navigator/open-external-url.md)(url: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), externalResultHandler: [ExternalResultHandler](../-external-result-handler/index.md))
Open the external url by browser or webview. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-download-navigator/on-file-download-start.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-download-navigator/on-file-download-start.md new file mode 100644 index 000000000..a44438243 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-download-navigator/on-file-download-start.md @@ -0,0 +1,24 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.navigator](../index.md)/[MiniAppDownloadNavigator](index.md)/[onFileDownloadStart](on-file-download-start.md) + +# onFileDownloadStart + +[androidJvm]\ +abstract fun [onFileDownloadStart](on-file-download-start.md)(url: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), userAgent: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), contentDisposition: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), mimetype: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), contentLength: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +Notify the host application that a file should be downloaded. + +Note that this will only receive requests When the mini app downloaded a file via JavaScript XHR. In this case the [url](on-file-download-start.md) received here will be a base64 data string which you must decode to bytes. + +In the case that a mini app wants to download a file from an external URL such as https://www.example.com/test.zip, the request will be sent to [MiniAppNavigator.openExternalUrl](../-mini-app-navigator/open-external-url.md), so you should handle this case in your custom WebView instance using [WebView.setDownloadListener](https://developer.android.com/reference/kotlin/android/webkit/WebView.html#setdownloadlistener). + +## Parameters + +androidJvm + +| | | +|---|---| +| url | The full url to the content that should be downloaded | +| userAgent | the user agent to be used for the download. | +| contentDisposition | Content-disposition http header, if present. | +| mimetype | The mimetype of the content reported by the server | +| contentLength | The file size reported by the server | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-external-url-loader/-companion/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-external-url-loader/-companion/index.md new file mode 100644 index 000000000..587f12d90 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-external-url-loader/-companion/index.md @@ -0,0 +1,19 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.navigator](../../index.md)/[MiniAppExternalUrlLoader](../index.md)/[Companion](index.md) + +# Companion + +[androidJvm]\ +object [Companion](index.md) + +## Functions + +| Name | Summary | +|---|---| +| [loaderWithId](loader-with-id.md) | [androidJvm]
fun [loaderWithId](loader-with-id.md)(miniAppId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), activity: [Activity](https://developer.android.com/reference/kotlin/android/app/Activity.html)? = null): [MiniAppExternalUrlLoader](../index.md)
Creates new MiniAppExternalUrlLoader. | +| [loaderWithUrl](loader-with-url.md) | [androidJvm]
fun [loaderWithUrl](loader-with-url.md)(customAppUrl: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), activity: [Activity](https://developer.android.com/reference/kotlin/android/app/Activity.html)? = null): [MiniAppExternalUrlLoader](../index.md)
Creates new MiniAppExternalUrlLoader. This should only be used for previewing a mini app from a local server. | + +## Properties + +| Name | Summary | +|---|---| +| [returnUrlTag](return-url-tag.md) | [androidJvm]
const val [returnUrlTag](return-url-tag.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-external-url-loader/-companion/loader-with-id.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-external-url-loader/-companion/loader-with-id.md new file mode 100644 index 000000000..2058c3603 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-external-url-loader/-companion/loader-with-id.md @@ -0,0 +1,17 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.navigator](../../index.md)/[MiniAppExternalUrlLoader](../index.md)/[Companion](index.md)/[loaderWithId](loader-with-id.md) + +# loaderWithId + +[androidJvm]\ +fun [loaderWithId](loader-with-id.md)(miniAppId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), activity: [Activity](https://developer.android.com/reference/kotlin/android/app/Activity.html)? = null): [MiniAppExternalUrlLoader](../index.md) + +Creates new MiniAppExternalUrlLoader. + +## Parameters + +androidJvm + +| | | +|---|---| +| miniAppId | The id of loading mini app. | +| activity | The Activity contains webview. Pass the activity if you want to auto finish the Activity with current external loading url as result data. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-external-url-loader/-companion/loader-with-url.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-external-url-loader/-companion/loader-with-url.md new file mode 100644 index 000000000..b66988500 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-external-url-loader/-companion/loader-with-url.md @@ -0,0 +1,17 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.navigator](../../index.md)/[MiniAppExternalUrlLoader](../index.md)/[Companion](index.md)/[loaderWithUrl](loader-with-url.md) + +# loaderWithUrl + +[androidJvm]\ +fun [loaderWithUrl](loader-with-url.md)(customAppUrl: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), activity: [Activity](https://developer.android.com/reference/kotlin/android/app/Activity.html)? = null): [MiniAppExternalUrlLoader](../index.md) + +Creates new MiniAppExternalUrlLoader. This should only be used for previewing a mini app from a local server. + +## Parameters + +androidJvm + +| | | +|---|---| +| customAppUrl | The url that was used to load the Mini App. | +| activity | The Activity contains webview. Pass the activity if you want to auto finish the Activity with current external loading url as result data. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-external-url-loader/-companion/return-url-tag.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-external-url-loader/-companion/return-url-tag.md new file mode 100644 index 000000000..0a3c24852 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-external-url-loader/-companion/return-url-tag.md @@ -0,0 +1,6 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.navigator](../../index.md)/[MiniAppExternalUrlLoader](../index.md)/[Companion](index.md)/[returnUrlTag](return-url-tag.md) + +# returnUrlTag + +[androidJvm]\ +const val [returnUrlTag](return-url-tag.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-external-url-loader/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-external-url-loader/index.md new file mode 100644 index 000000000..cf9ce4070 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-external-url-loader/index.md @@ -0,0 +1,21 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.navigator](../index.md)/[MiniAppExternalUrlLoader](index.md) + +# MiniAppExternalUrlLoader + +[androidJvm]\ +class [MiniAppExternalUrlLoader](index.md) + +This support the scenario that external loader redirect to url which is only supported in mini app view, close the external loader and emit that url to mini app view by [ExternalResultHandler.emitResult](../-external-result-handler/emit-result.md). + +## Types + +| Name | Summary | +|---|---| +| [Companion](-companion/index.md) | [androidJvm]
object [Companion](-companion/index.md) | + +## Functions + +| Name | Summary | +|---|---| +| [shouldClose](should-close.md) | [androidJvm]
fun [shouldClose](should-close.md)(url: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
In case you do not want to finish activity which contains webview automatically, use this to check should stop the external webview loader and send the current url to mini app view. | +| [shouldOverrideUrlLoading](should-override-url-loading.md) | [androidJvm]
fun [shouldOverrideUrlLoading](should-override-url-loading.md)(url: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Determine to close the external loader. Use this in the return value of WebViewClient.shouldOverrideUrlLoading(WebView, WebResourceRequest). | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-external-url-loader/should-close.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-external-url-loader/should-close.md new file mode 100644 index 000000000..080df6f77 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-external-url-loader/should-close.md @@ -0,0 +1,8 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.navigator](../index.md)/[MiniAppExternalUrlLoader](index.md)/[shouldClose](should-close.md) + +# shouldClose + +[androidJvm]\ +fun [shouldClose](should-close.md)(url: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +In case you do not want to finish activity which contains webview automatically, use this to check should stop the external webview loader and send the current url to mini app view. diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-external-url-loader/should-override-url-loading.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-external-url-loader/should-override-url-loading.md new file mode 100644 index 000000000..f8b62b23c --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-external-url-loader/should-override-url-loading.md @@ -0,0 +1,8 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.navigator](../index.md)/[MiniAppExternalUrlLoader](index.md)/[shouldOverrideUrlLoading](should-override-url-loading.md) + +# shouldOverrideUrlLoading + +[androidJvm]\ +fun [shouldOverrideUrlLoading](should-override-url-loading.md)(url: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Determine to close the external loader. Use this in the return value of WebViewClient.shouldOverrideUrlLoading(WebView, WebResourceRequest). diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-navigator/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-navigator/index.md new file mode 100644 index 000000000..5b3c82c4f --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-navigator/index.md @@ -0,0 +1,20 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.navigator](../index.md)/[MiniAppNavigator](index.md) + +# MiniAppNavigator + +[androidJvm]\ +interface [MiniAppNavigator](index.md) + +The navigation controller of sdk mini app view. You can optionally pass an implementation of this when creating a mini app using [MiniApp.create](../../com.rakuten.tech.mobile.miniapp/-mini-app/create.md) + +## Functions + +| Name | Summary | +|---|---| +| [openExternalUrl](open-external-url.md) | [androidJvm]
abstract fun [openExternalUrl](open-external-url.md)(url: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), externalResultHandler: [ExternalResultHandler](../-external-result-handler/index.md))
Open the external url by browser or webview. | + +## Inheritors + +| Name | +|---| +| [MiniAppDownloadNavigator](../-mini-app-download-navigator/index.md) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-navigator/open-external-url.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-navigator/open-external-url.md new file mode 100644 index 000000000..5c9aabf98 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-navigator/open-external-url.md @@ -0,0 +1,17 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.navigator](../index.md)/[MiniAppNavigator](index.md)/[openExternalUrl](open-external-url.md) + +# openExternalUrl + +[androidJvm]\ +abstract fun [openExternalUrl](open-external-url.md)(url: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), externalResultHandler: [ExternalResultHandler](../-external-result-handler/index.md)) + +Open the external url by browser or webview. + +## Parameters + +androidJvm + +| | | +|---|---| +| url | The detected external url. This url is sent from mini app view. | +| externalResultHandler | Use this to send any result such as url to mini app view. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/index.md new file mode 100644 index 000000000..cf7706560 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.navigator/index.md @@ -0,0 +1,12 @@ +//[miniapp](../../index.md)/[com.rakuten.tech.mobile.miniapp.navigator](index.md) + +# Package com.rakuten.tech.mobile.miniapp.navigator + +## Types + +| Name | Summary | +|---|---| +| [ExternalResultHandler](-external-result-handler/index.md) | [androidJvm]
class [ExternalResultHandler](-external-result-handler/index.md)
The url transmitter from external factors to mini app view. | +| [MiniAppDownloadNavigator](-mini-app-download-navigator/index.md) | [androidJvm]
interface [MiniAppDownloadNavigator](-mini-app-download-navigator/index.md) : [MiniAppNavigator](-mini-app-navigator/index.md)
File download controller for mini app view. This interface can optionally be used with your MiniAppNavigator if you wish to intercept file download requests from the mini app. If you do not use this interface, then default handling will be used for file download requests. | +| [MiniAppExternalUrlLoader](-mini-app-external-url-loader/index.md) | [androidJvm]
class [MiniAppExternalUrlLoader](-mini-app-external-url-loader/index.md)
This support the scenario that external loader redirect to url which is only supported in mini app view, close the external loader and emit that url to mini app view by [ExternalResultHandler.emitResult](-external-result-handler/emit-result.md). | +| [MiniAppNavigator](-mini-app-navigator/index.md) | [androidJvm]
interface [MiniAppNavigator](-mini-app-navigator/index.md)
The navigation controller of sdk mini app view. You can optionally pass an implementation of this when creating a mini app using [MiniApp.create](../com.rakuten.tech.mobile.miniapp/-mini-app/create.md) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-access-token-scope/-access-token-scope.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-access-token-scope/-access-token-scope.md new file mode 100644 index 000000000..92dae68b9 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-access-token-scope/-access-token-scope.md @@ -0,0 +1,8 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.permission](../index.md)/[AccessTokenScope](index.md)/[AccessTokenScope](-access-token-scope.md) + +# AccessTokenScope + +[androidJvm]\ +fun [AccessTokenScope](-access-token-scope.md)() + +fun [AccessTokenScope](-access-token-scope.md)(audience: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), scopes: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-access-token-scope/audience.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-access-token-scope/audience.md new file mode 100644 index 000000000..9aef54855 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-access-token-scope/audience.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.permission](../index.md)/[AccessTokenScope](index.md)/[audience](audience.md) + +# audience + +[androidJvm]\ +val [audience](audience.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-access-token-scope/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-access-token-scope/index.md new file mode 100644 index 000000000..87b3be986 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-access-token-scope/index.md @@ -0,0 +1,22 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.permission](../index.md)/[AccessTokenScope](index.md) + +# AccessTokenScope + +[androidJvm]\ +data class [AccessTokenScope](index.md)(audience: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), scopes: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>) + +Contains the components which need to be validated when access token is granted. + +## Constructors + +| | | +|---|---| +| [AccessTokenScope](-access-token-scope.md) | [androidJvm]
fun [AccessTokenScope](-access-token-scope.md)() | +| [AccessTokenScope](-access-token-scope.md) | [androidJvm]
fun [AccessTokenScope](-access-token-scope.md)(audience: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), scopes: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>) | + +## Properties + +| Name | Summary | +|---|---| +| [audience](audience.md) | [androidJvm]
val [audience](audience.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
The service of access token. | +| [scopes](scopes.md) | [androidJvm]
val [scopes](scopes.md): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>
List of areas that token can access. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-access-token-scope/scopes.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-access-token-scope/scopes.md new file mode 100644 index 000000000..7f527d601 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-access-token-scope/scopes.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.permission](../index.md)/[AccessTokenScope](index.md)/[scopes](scopes.md) + +# scopes + +[androidJvm]\ +val [scopes](scopes.md): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)> diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-response/-custom-permission-response-obj/-custom-permission-response-obj.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-response/-custom-permission-response-obj/-custom-permission-response-obj.md new file mode 100644 index 000000000..0464d82b4 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-response/-custom-permission-response-obj/-custom-permission-response-obj.md @@ -0,0 +1,6 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.permission](../../index.md)/[MiniAppCustomPermissionResponse](../index.md)/[CustomPermissionResponseObj](index.md)/[CustomPermissionResponseObj](-custom-permission-response-obj.md) + +# CustomPermissionResponseObj + +[androidJvm]\ +fun [CustomPermissionResponseObj](-custom-permission-response-obj.md)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), status: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-response/-custom-permission-response-obj/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-response/-custom-permission-response-obj/index.md new file mode 100644 index 000000000..2439035c6 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-response/-custom-permission-response-obj/index.md @@ -0,0 +1,21 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.permission](../../index.md)/[MiniAppCustomPermissionResponse](../index.md)/[CustomPermissionResponseObj](index.md) + +# CustomPermissionResponseObj + +[androidJvm]\ +data class [CustomPermissionResponseObj](index.md)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), status: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) + +A data class to hold the json elements to be sent as inside the response. + +## Constructors + +| | | +|---|---| +| [CustomPermissionResponseObj](-custom-permission-response-obj.md) | [androidJvm]
fun [CustomPermissionResponseObj](-custom-permission-response-obj.md)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), status: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) | + +## Properties + +| Name | Summary | +|---|---| +| [name](name.md) | [androidJvm]
val [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [status](status.md) | [androidJvm]
val [status](status.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-response/-custom-permission-response-obj/name.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-response/-custom-permission-response-obj/name.md new file mode 100644 index 000000000..aad5a403a --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-response/-custom-permission-response-obj/name.md @@ -0,0 +1,6 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.permission](../../index.md)/[MiniAppCustomPermissionResponse](../index.md)/[CustomPermissionResponseObj](index.md)/[name](name.md) + +# name + +[androidJvm]\ +val [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-response/-custom-permission-response-obj/status.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-response/-custom-permission-response-obj/status.md new file mode 100644 index 000000000..b4fb8482d --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-response/-custom-permission-response-obj/status.md @@ -0,0 +1,6 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.permission](../../index.md)/[MiniAppCustomPermissionResponse](../index.md)/[CustomPermissionResponseObj](index.md)/[status](status.md) + +# status + +[androidJvm]\ +val [status](status.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-response/-mini-app-custom-permission-response.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-response/-mini-app-custom-permission-response.md new file mode 100644 index 000000000..c9b6f8c69 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-response/-mini-app-custom-permission-response.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.permission](../index.md)/[MiniAppCustomPermissionResponse](index.md)/[MiniAppCustomPermissionResponse](-mini-app-custom-permission-response.md) + +# MiniAppCustomPermissionResponse + +[androidJvm]\ +fun [MiniAppCustomPermissionResponse](-mini-app-custom-permission-response.md)(permissions: [ArrayList](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-array-list/index.html)<[MiniAppCustomPermissionResponse.CustomPermissionResponseObj](-custom-permission-response-obj/index.md)>) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-response/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-response/index.md new file mode 100644 index 000000000..db0caf062 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-response/index.md @@ -0,0 +1,26 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.permission](../index.md)/[MiniAppCustomPermissionResponse](index.md) + +# MiniAppCustomPermissionResponse + +[androidJvm]\ +data class [MiniAppCustomPermissionResponse](index.md)(permissions: [ArrayList](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-array-list/index.html)<[MiniAppCustomPermissionResponse.CustomPermissionResponseObj](-custom-permission-response-obj/index.md)>) + +A data class to prepare the json response of custom permissions to be sent from this SDK. + +## Constructors + +| | | +|---|---| +| [MiniAppCustomPermissionResponse](-mini-app-custom-permission-response.md) | [androidJvm]
fun [MiniAppCustomPermissionResponse](-mini-app-custom-permission-response.md)(permissions: [ArrayList](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-array-list/index.html)<[MiniAppCustomPermissionResponse.CustomPermissionResponseObj](-custom-permission-response-obj/index.md)>) | + +## Types + +| Name | Summary | +|---|---| +| [CustomPermissionResponseObj](-custom-permission-response-obj/index.md) | [androidJvm]
data class [CustomPermissionResponseObj](-custom-permission-response-obj/index.md)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), status: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html))
A data class to hold the json elements to be sent as inside the response. | + +## Properties + +| Name | Summary | +|---|---| +| [permissions](permissions.md) | [androidJvm]
val [permissions](permissions.md): [ArrayList](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-array-list/index.html)<[MiniAppCustomPermissionResponse.CustomPermissionResponseObj](-custom-permission-response-obj/index.md)> | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-response/permissions.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-response/permissions.md new file mode 100644 index 000000000..b60a7a223 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-response/permissions.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.permission](../index.md)/[MiniAppCustomPermissionResponse](index.md)/[permissions](permissions.md) + +# permissions + +[androidJvm]\ +val [permissions](permissions.md): [ArrayList](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-array-list/index.html)<[MiniAppCustomPermissionResponse.CustomPermissionResponseObj](-custom-permission-response-obj/index.md)> diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md new file mode 100644 index 000000000..aec914a04 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md @@ -0,0 +1,13 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.permission](../../index.md)/[MiniAppCustomPermissionResult](../index.md)/[ALLOWED](index.md) + +# ALLOWED + +[androidJvm]\ +[ALLOWED](index.md)() + +## Properties + +| Name | Summary | +|---|---| +| [name](index.md#-372974862%2FProperties%2F1451286739) | [androidJvm]
val [name](index.md#-372974862%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](index.md#-739389684%2FProperties%2F1451286739) | [androidJvm]
val [ordinal](index.md#-739389684%2FProperties%2F1451286739): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-d-e-n-i-e-d/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-d-e-n-i-e-d/index.md new file mode 100644 index 000000000..215f1956f --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-d-e-n-i-e-d/index.md @@ -0,0 +1,13 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.permission](../../index.md)/[MiniAppCustomPermissionResult](../index.md)/[DENIED](index.md) + +# DENIED + +[androidJvm]\ +[DENIED](index.md)() + +## Properties + +| Name | Summary | +|---|---| +| [name](../-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739) | [androidJvm]
val [name](../-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739) | [androidJvm]
val [ordinal](../-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-p-e-r-m-i-s-s-i-o-n_-n-o-t_-a-v-a-i-l-a-b-l-e/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-p-e-r-m-i-s-s-i-o-n_-n-o-t_-a-v-a-i-l-a-b-l-e/index.md new file mode 100644 index 000000000..64863a8c9 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-p-e-r-m-i-s-s-i-o-n_-n-o-t_-a-v-a-i-l-a-b-l-e/index.md @@ -0,0 +1,13 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.permission](../../index.md)/[MiniAppCustomPermissionResult](../index.md)/[PERMISSION_NOT_AVAILABLE](index.md) + +# PERMISSION_NOT_AVAILABLE + +[androidJvm]\ +[PERMISSION_NOT_AVAILABLE](index.md)() + +## Properties + +| Name | Summary | +|---|---| +| [name](../-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739) | [androidJvm]
val [name](../-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739) | [androidJvm]
val [ordinal](../-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/index.md new file mode 100644 index 000000000..17831d6e3 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/index.md @@ -0,0 +1,23 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.permission](../index.md)/[MiniAppCustomPermissionResult](index.md) + +# MiniAppCustomPermissionResult + +[androidJvm]\ +enum [MiniAppCustomPermissionResult](index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[MiniAppCustomPermissionResult](index.md)> + +Type of miniapp custom permission result. + +## Entries + +| | | +|---|---| +| [PERMISSION_NOT_AVAILABLE](-p-e-r-m-i-s-s-i-o-n_-n-o-t_-a-v-a-i-l-a-b-l-e/index.md) | [androidJvm]
[PERMISSION_NOT_AVAILABLE](-p-e-r-m-i-s-s-i-o-n_-n-o-t_-a-v-a-i-l-a-b-l-e/index.md)() | +| [DENIED](-d-e-n-i-e-d/index.md) | [androidJvm]
[DENIED](-d-e-n-i-e-d/index.md)() | +| [ALLOWED](-a-l-l-o-w-e-d/index.md) | [androidJvm]
[ALLOWED](-a-l-l-o-w-e-d/index.md)() | + +## Properties + +| Name | Summary | +|---|---| +| [name](-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739) | [androidJvm]
val [name](-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739) | [androidJvm]
val [ordinal](-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-a-c-c-e-s-s_-t-o-k-e-n/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-a-c-c-e-s-s_-t-o-k-e-n/index.md new file mode 100644 index 000000000..e7525ca3a --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-a-c-c-e-s-s_-t-o-k-e-n/index.md @@ -0,0 +1,14 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.permission](../../index.md)/[MiniAppCustomPermissionType](../index.md)/[ACCESS_TOKEN](index.md) + +# ACCESS_TOKEN + +[androidJvm]\ +[ACCESS_TOKEN](index.md)("rakuten.miniapp.user.ACCESS_TOKEN") + +## Properties + +| Name | Summary | +|---|---| +| [name](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739) | [androidJvm]
val [name](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739) | [androidJvm]
val [ordinal](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [type](../type.md) | [androidJvm]
val [type](../type.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-c-o-n-t-a-c-t_-l-i-s-t/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-c-o-n-t-a-c-t_-l-i-s-t/index.md new file mode 100644 index 000000000..237745e89 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-c-o-n-t-a-c-t_-l-i-s-t/index.md @@ -0,0 +1,14 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.permission](../../index.md)/[MiniAppCustomPermissionType](../index.md)/[CONTACT_LIST](index.md) + +# CONTACT_LIST + +[androidJvm]\ +[CONTACT_LIST](index.md)("rakuten.miniapp.user.CONTACT_LIST") + +## Properties + +| Name | Summary | +|---|---| +| [name](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739) | [androidJvm]
val [name](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739) | [androidJvm]
val [ordinal](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [type](../type.md) | [androidJvm]
val [type](../type.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-f-i-l-e_-d-o-w-n-l-o-a-d/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-f-i-l-e_-d-o-w-n-l-o-a-d/index.md new file mode 100644 index 000000000..15eb3fec2 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-f-i-l-e_-d-o-w-n-l-o-a-d/index.md @@ -0,0 +1,14 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.permission](../../index.md)/[MiniAppCustomPermissionType](../index.md)/[FILE_DOWNLOAD](index.md) + +# FILE_DOWNLOAD + +[androidJvm]\ +[FILE_DOWNLOAD](index.md)("rakuten.miniapp.device.FILE_DOWNLOAD") + +## Properties + +| Name | Summary | +|---|---| +| [name](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739) | [androidJvm]
val [name](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739) | [androidJvm]
val [ordinal](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [type](../type.md) | [androidJvm]
val [type](../type.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-l-o-c-a-t-i-o-n/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-l-o-c-a-t-i-o-n/index.md new file mode 100644 index 000000000..97168cc0d --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-l-o-c-a-t-i-o-n/index.md @@ -0,0 +1,14 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.permission](../../index.md)/[MiniAppCustomPermissionType](../index.md)/[LOCATION](index.md) + +# LOCATION + +[androidJvm]\ +[LOCATION](index.md)("rakuten.miniapp.device.LOCATION") + +## Properties + +| Name | Summary | +|---|---| +| [name](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739) | [androidJvm]
val [name](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739) | [androidJvm]
val [ordinal](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [type](../type.md) | [androidJvm]
val [type](../type.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-p-o-i-n-t-s/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-p-o-i-n-t-s/index.md new file mode 100644 index 000000000..eb81ce1b3 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-p-o-i-n-t-s/index.md @@ -0,0 +1,14 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.permission](../../index.md)/[MiniAppCustomPermissionType](../index.md)/[POINTS](index.md) + +# POINTS + +[androidJvm]\ +[POINTS](index.md)("rakuten.miniapp.user.POINTS") + +## Properties + +| Name | Summary | +|---|---| +| [name](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739) | [androidJvm]
val [name](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739) | [androidJvm]
val [ordinal](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [type](../type.md) | [androidJvm]
val [type](../type.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-p-r-o-f-i-l-e_-p-h-o-t-o/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-p-r-o-f-i-l-e_-p-h-o-t-o/index.md new file mode 100644 index 000000000..d34abc933 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-p-r-o-f-i-l-e_-p-h-o-t-o/index.md @@ -0,0 +1,14 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.permission](../../index.md)/[MiniAppCustomPermissionType](../index.md)/[PROFILE_PHOTO](index.md) + +# PROFILE_PHOTO + +[androidJvm]\ +[PROFILE_PHOTO](index.md)("rakuten.miniapp.user.PROFILE_PHOTO") + +## Properties + +| Name | Summary | +|---|---| +| [name](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739) | [androidJvm]
val [name](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739) | [androidJvm]
val [ordinal](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [type](../type.md) | [androidJvm]
val [type](../type.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-s-e-n-d_-m-e-s-s-a-g-e/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-s-e-n-d_-m-e-s-s-a-g-e/index.md new file mode 100644 index 000000000..1ca1a6fa0 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-s-e-n-d_-m-e-s-s-a-g-e/index.md @@ -0,0 +1,14 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.permission](../../index.md)/[MiniAppCustomPermissionType](../index.md)/[SEND_MESSAGE](index.md) + +# SEND_MESSAGE + +[androidJvm]\ +[SEND_MESSAGE](index.md)("rakuten.miniapp.user.action.SEND_MESSAGE") + +## Properties + +| Name | Summary | +|---|---| +| [name](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739) | [androidJvm]
val [name](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739) | [androidJvm]
val [ordinal](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [type](../type.md) | [androidJvm]
val [type](../type.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-u-n-k-n-o-w-n/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-u-n-k-n-o-w-n/index.md new file mode 100644 index 000000000..464ffa2d2 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-u-n-k-n-o-w-n/index.md @@ -0,0 +1,14 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.permission](../../index.md)/[MiniAppCustomPermissionType](../index.md)/[UNKNOWN](index.md) + +# UNKNOWN + +[androidJvm]\ +[UNKNOWN](index.md)("UNKNOWN") + +## Properties + +| Name | Summary | +|---|---| +| [name](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739) | [androidJvm]
val [name](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739) | [androidJvm]
val [ordinal](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [type](../type.md) | [androidJvm]
val [type](../type.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-u-s-e-r_-n-a-m-e/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-u-s-e-r_-n-a-m-e/index.md new file mode 100644 index 000000000..c048e69ba --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-u-s-e-r_-n-a-m-e/index.md @@ -0,0 +1,14 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.permission](../../index.md)/[MiniAppCustomPermissionType](../index.md)/[USER_NAME](index.md) + +# USER_NAME + +[androidJvm]\ +[USER_NAME](index.md)("rakuten.miniapp.user.USER_NAME") + +## Properties + +| Name | Summary | +|---|---| +| [name](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739) | [androidJvm]
val [name](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739) | [androidJvm]
val [ordinal](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [type](../type.md) | [androidJvm]
val [type](../type.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/index.md new file mode 100644 index 000000000..073b0f1bb --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/index.md @@ -0,0 +1,30 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.permission](../index.md)/[MiniAppCustomPermissionType](index.md) + +# MiniAppCustomPermissionType + +[androidJvm]\ +enum [MiniAppCustomPermissionType](index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[MiniAppCustomPermissionType](index.md)> + +Type of miniapp custom permission. + +## Entries + +| | | +|---|---| +| [UNKNOWN](-u-n-k-n-o-w-n/index.md) | [androidJvm]
[UNKNOWN](-u-n-k-n-o-w-n/index.md)("UNKNOWN") | +| [FILE_DOWNLOAD](-f-i-l-e_-d-o-w-n-l-o-a-d/index.md) | [androidJvm]
[FILE_DOWNLOAD](-f-i-l-e_-d-o-w-n-l-o-a-d/index.md)("rakuten.miniapp.device.FILE_DOWNLOAD") | +| [POINTS](-p-o-i-n-t-s/index.md) | [androidJvm]
[POINTS](-p-o-i-n-t-s/index.md)("rakuten.miniapp.user.POINTS") | +| [LOCATION](-l-o-c-a-t-i-o-n/index.md) | [androidJvm]
[LOCATION](-l-o-c-a-t-i-o-n/index.md)("rakuten.miniapp.device.LOCATION") | +| [SEND_MESSAGE](-s-e-n-d_-m-e-s-s-a-g-e/index.md) | [androidJvm]
[SEND_MESSAGE](-s-e-n-d_-m-e-s-s-a-g-e/index.md)("rakuten.miniapp.user.action.SEND_MESSAGE") | +| [ACCESS_TOKEN](-a-c-c-e-s-s_-t-o-k-e-n/index.md) | [androidJvm]
[ACCESS_TOKEN](-a-c-c-e-s-s_-t-o-k-e-n/index.md)("rakuten.miniapp.user.ACCESS_TOKEN") | +| [CONTACT_LIST](-c-o-n-t-a-c-t_-l-i-s-t/index.md) | [androidJvm]
[CONTACT_LIST](-c-o-n-t-a-c-t_-l-i-s-t/index.md)("rakuten.miniapp.user.CONTACT_LIST") | +| [PROFILE_PHOTO](-p-r-o-f-i-l-e_-p-h-o-t-o/index.md) | [androidJvm]
[PROFILE_PHOTO](-p-r-o-f-i-l-e_-p-h-o-t-o/index.md)("rakuten.miniapp.user.PROFILE_PHOTO") | +| [USER_NAME](-u-s-e-r_-n-a-m-e/index.md) | [androidJvm]
[USER_NAME](-u-s-e-r_-n-a-m-e/index.md)("rakuten.miniapp.user.USER_NAME") | + +## Properties + +| Name | Summary | +|---|---| +| [name](../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739) | [androidJvm]
val [name](../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739) | [androidJvm]
val [ordinal](../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [type](type.md) | [androidJvm]
val [type](type.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/type.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/type.md new file mode 100644 index 000000000..e729e3c5c --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/type.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.permission](../index.md)/[MiniAppCustomPermissionType](index.md)/[type](type.md) + +# type + +[androidJvm]\ +val [type](type.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission/-mini-app-custom-permission.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission/-mini-app-custom-permission.md new file mode 100644 index 000000000..a04778b00 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission/-mini-app-custom-permission.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.permission](../index.md)/[MiniAppCustomPermission](index.md)/[MiniAppCustomPermission](-mini-app-custom-permission.md) + +# MiniAppCustomPermission + +[androidJvm]\ +fun [MiniAppCustomPermission](-mini-app-custom-permission.md)(miniAppId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), pairValues: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[Pair](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)<[MiniAppCustomPermissionType](../-mini-app-custom-permission-type/index.md), [MiniAppCustomPermissionResult](../-mini-app-custom-permission-result/index.md)>>) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission/index.md new file mode 100644 index 000000000..c5a83c0c1 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission/index.md @@ -0,0 +1,21 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.permission](../index.md)/[MiniAppCustomPermission](index.md) + +# MiniAppCustomPermission + +[androidJvm]\ +data class [MiniAppCustomPermission](index.md)(miniAppId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), pairValues: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[Pair](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)<[MiniAppCustomPermissionType](../-mini-app-custom-permission-type/index.md), [MiniAppCustomPermissionResult](../-mini-app-custom-permission-result/index.md)>>) + +A data class to hold the custom permission with grant results using Pair per MiniApp. + +## Constructors + +| | | +|---|---| +| [MiniAppCustomPermission](-mini-app-custom-permission.md) | [androidJvm]
fun [MiniAppCustomPermission](-mini-app-custom-permission.md)(miniAppId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), pairValues: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[Pair](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)<[MiniAppCustomPermissionType](../-mini-app-custom-permission-type/index.md), [MiniAppCustomPermissionResult](../-mini-app-custom-permission-result/index.md)>>) | + +## Properties + +| Name | Summary | +|---|---| +| [miniAppId](mini-app-id.md) | [androidJvm]
val [miniAppId](mini-app-id.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [pairValues](pair-values.md) | [androidJvm]
val [pairValues](pair-values.md): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[Pair](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)<[MiniAppCustomPermissionType](../-mini-app-custom-permission-type/index.md), [MiniAppCustomPermissionResult](../-mini-app-custom-permission-result/index.md)>> | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission/mini-app-id.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission/mini-app-id.md new file mode 100644 index 000000000..aec56840d --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission/mini-app-id.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.permission](../index.md)/[MiniAppCustomPermission](index.md)/[miniAppId](mini-app-id.md) + +# miniAppId + +[androidJvm]\ +val [miniAppId](mini-app-id.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission/pair-values.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission/pair-values.md new file mode 100644 index 000000000..276a8398b --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission/pair-values.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.permission](../index.md)/[MiniAppCustomPermission](index.md)/[pairValues](pair-values.md) + +# pairValues + +[androidJvm]\ +val [pairValues](pair-values.md): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[Pair](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)<[MiniAppCustomPermissionType](../-mini-app-custom-permission-type/index.md), [MiniAppCustomPermissionResult](../-mini-app-custom-permission-result/index.md)>> diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-device-permission-type/-c-a-m-e-r-a/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-device-permission-type/-c-a-m-e-r-a/index.md new file mode 100644 index 000000000..16ee36d87 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-device-permission-type/-c-a-m-e-r-a/index.md @@ -0,0 +1,14 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.permission](../../index.md)/[MiniAppDevicePermissionType](../index.md)/[CAMERA](index.md) + +# CAMERA + +[androidJvm]\ +[CAMERA](index.md)("camera") + +## Properties + +| Name | Summary | +|---|---| +| [name](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739) | [androidJvm]
val [name](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739) | [androidJvm]
val [ordinal](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [type](../type.md) | [androidJvm]
val [type](../type.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-device-permission-type/-l-o-c-a-t-i-o-n/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-device-permission-type/-l-o-c-a-t-i-o-n/index.md new file mode 100644 index 000000000..da023a6f2 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-device-permission-type/-l-o-c-a-t-i-o-n/index.md @@ -0,0 +1,14 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.permission](../../index.md)/[MiniAppDevicePermissionType](../index.md)/[LOCATION](index.md) + +# LOCATION + +[androidJvm]\ +[LOCATION](index.md)("location") + +## Properties + +| Name | Summary | +|---|---| +| [name](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739) | [androidJvm]
val [name](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739) | [androidJvm]
val [ordinal](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [type](../type.md) | [androidJvm]
val [type](../type.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-device-permission-type/-u-n-k-n-o-w-n/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-device-permission-type/-u-n-k-n-o-w-n/index.md new file mode 100644 index 000000000..50f02ade9 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-device-permission-type/-u-n-k-n-o-w-n/index.md @@ -0,0 +1,14 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.permission](../../index.md)/[MiniAppDevicePermissionType](../index.md)/[UNKNOWN](index.md) + +# UNKNOWN + +[androidJvm]\ +[UNKNOWN](index.md)("unknown") + +## Properties + +| Name | Summary | +|---|---| +| [name](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739) | [androidJvm]
val [name](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739) | [androidJvm]
val [ordinal](../../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [type](../type.md) | [androidJvm]
val [type](../type.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-device-permission-type/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-device-permission-type/index.md new file mode 100644 index 000000000..5dc362ce0 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-device-permission-type/index.md @@ -0,0 +1,24 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.permission](../index.md)/[MiniAppDevicePermissionType](index.md) + +# MiniAppDevicePermissionType + +[androidJvm]\ +enum [MiniAppDevicePermissionType](index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[MiniAppDevicePermissionType](index.md)> + +Type of miniapp device permission. + +## Entries + +| | | +|---|---| +| [CAMERA](-c-a-m-e-r-a/index.md) | [androidJvm]
[CAMERA](-c-a-m-e-r-a/index.md)("camera") | +| [LOCATION](-l-o-c-a-t-i-o-n/index.md) | [androidJvm]
[LOCATION](-l-o-c-a-t-i-o-n/index.md)("location") | +| [UNKNOWN](-u-n-k-n-o-w-n/index.md) | [androidJvm]
[UNKNOWN](-u-n-k-n-o-w-n/index.md)("unknown") | + +## Properties + +| Name | Summary | +|---|---| +| [name](../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739) | [androidJvm]
val [name](../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-372974862%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739) | [androidJvm]
val [ordinal](../-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md#-739389684%2FProperties%2F1451286739): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [type](type.md) | [androidJvm]
val [type](type.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-device-permission-type/type.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-device-permission-type/type.md new file mode 100644 index 000000000..2255bef35 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-device-permission-type/type.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.permission](../index.md)/[MiniAppDevicePermissionType](index.md)/[type](type.md) + +# type + +[androidJvm]\ +val [type](type.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/index.md new file mode 100644 index 000000000..f2159876f --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.permission/index.md @@ -0,0 +1,14 @@ +//[miniapp](../../index.md)/[com.rakuten.tech.mobile.miniapp.permission](index.md) + +# Package com.rakuten.tech.mobile.miniapp.permission + +## Types + +| Name | Summary | +|---|---| +| [AccessTokenScope](-access-token-scope/index.md) | [androidJvm]
data class [AccessTokenScope](-access-token-scope/index.md)(audience: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), scopes: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>)
Contains the components which need to be validated when access token is granted. | +| [MiniAppCustomPermission](-mini-app-custom-permission/index.md) | [androidJvm]
data class [MiniAppCustomPermission](-mini-app-custom-permission/index.md)(miniAppId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), pairValues: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[Pair](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)<[MiniAppCustomPermissionType](-mini-app-custom-permission-type/index.md), [MiniAppCustomPermissionResult](-mini-app-custom-permission-result/index.md)>>)
A data class to hold the custom permission with grant results using Pair per MiniApp. | +| [MiniAppCustomPermissionResponse](-mini-app-custom-permission-response/index.md) | [androidJvm]
data class [MiniAppCustomPermissionResponse](-mini-app-custom-permission-response/index.md)(permissions: [ArrayList](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-array-list/index.html)<[MiniAppCustomPermissionResponse.CustomPermissionResponseObj](-mini-app-custom-permission-response/-custom-permission-response-obj/index.md)>)
A data class to prepare the json response of custom permissions to be sent from this SDK. | +| [MiniAppCustomPermissionResult](-mini-app-custom-permission-result/index.md) | [androidJvm]
enum [MiniAppCustomPermissionResult](-mini-app-custom-permission-result/index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[MiniAppCustomPermissionResult](-mini-app-custom-permission-result/index.md)>
Type of miniapp custom permission result. | +| [MiniAppCustomPermissionType](-mini-app-custom-permission-type/index.md) | [androidJvm]
enum [MiniAppCustomPermissionType](-mini-app-custom-permission-type/index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[MiniAppCustomPermissionType](-mini-app-custom-permission-type/index.md)>
Type of miniapp custom permission. | +| [MiniAppDevicePermissionType](-mini-app-device-permission-type/index.md) | [androidJvm]
enum [MiniAppDevicePermissionType](-mini-app-device-permission-type/index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[MiniAppDevicePermissionType](-mini-app-device-permission-type/index.md)>
Type of miniapp device permission. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-base-url-exception/-invalid-signature-verifier-base-url-exception.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-base-url-exception/-invalid-signature-verifier-base-url-exception.md new file mode 100644 index 000000000..bc42a712e --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-base-url-exception/-invalid-signature-verifier-base-url-exception.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.signatureverifier.api](../index.md)/[InvalidSignatureVerifierBaseUrlException](index.md)/[InvalidSignatureVerifierBaseUrlException](-invalid-signature-verifier-base-url-exception.md) + +# InvalidSignatureVerifierBaseUrlException + +[androidJvm]\ +fun [InvalidSignatureVerifierBaseUrlException](-invalid-signature-verifier-base-url-exception.md)(exception: [IllegalArgumentException](https://developer.android.com/reference/kotlin/java/lang/IllegalArgumentException.html)) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-base-url-exception/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-base-url-exception/index.md new file mode 100644 index 000000000..0c8eeb551 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-base-url-exception/index.md @@ -0,0 +1,34 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.signatureverifier.api](../index.md)/[InvalidSignatureVerifierBaseUrlException](index.md) + +# InvalidSignatureVerifierBaseUrlException + +[androidJvm]\ +class [InvalidSignatureVerifierBaseUrlException](index.md)(exception: [IllegalArgumentException](https://developer.android.com/reference/kotlin/java/lang/IllegalArgumentException.html)) : [IllegalArgumentException](https://developer.android.com/reference/kotlin/java/lang/IllegalArgumentException.html) + +Exception thrown when endpoint is not a valid URL. + +## Constructors + +| | | +|---|---| +| [InvalidSignatureVerifierBaseUrlException](-invalid-signature-verifier-base-url-exception.md) | [androidJvm]
fun [InvalidSignatureVerifierBaseUrlException](-invalid-signature-verifier-base-url-exception.md)(exception: [IllegalArgumentException](https://developer.android.com/reference/kotlin/java/lang/IllegalArgumentException.html)) | + +## Functions + +| Name | Summary | +|---|---| +| [addSuppressed](../-invalid-signature-verifier-subscription-exception/index.md#282858770%2FFunctions%2F1451286739) | [androidJvm]
fun [addSuppressed](../-invalid-signature-verifier-subscription-exception/index.md#282858770%2FFunctions%2F1451286739)(p0: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) | +| [fillInStackTrace](../-invalid-signature-verifier-subscription-exception/index.md#-1102069925%2FFunctions%2F1451286739) | [androidJvm]
open fun [fillInStackTrace](../-invalid-signature-verifier-subscription-exception/index.md#-1102069925%2FFunctions%2F1451286739)(): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) | +| [getLocalizedMessage](../-invalid-signature-verifier-subscription-exception/index.md#1043865560%2FFunctions%2F1451286739) | [androidJvm]
open fun [getLocalizedMessage](../-invalid-signature-verifier-subscription-exception/index.md#1043865560%2FFunctions%2F1451286739)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [getStackTrace](../-invalid-signature-verifier-subscription-exception/index.md#2050903719%2FFunctions%2F1451286739) | [androidJvm]
open fun [getStackTrace](../-invalid-signature-verifier-subscription-exception/index.md#2050903719%2FFunctions%2F1451286739)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[StackTraceElement](https://developer.android.com/reference/kotlin/java/lang/StackTraceElement.html)> | +| [getSuppressed](../-invalid-signature-verifier-subscription-exception/index.md#672492560%2FFunctions%2F1451286739) | [androidJvm]
fun [getSuppressed](../-invalid-signature-verifier-subscription-exception/index.md#672492560%2FFunctions%2F1451286739)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)> | +| [initCause](../-invalid-signature-verifier-subscription-exception/index.md#-418225042%2FFunctions%2F1451286739) | [androidJvm]
open fun [initCause](../-invalid-signature-verifier-subscription-exception/index.md#-418225042%2FFunctions%2F1451286739)(p0: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) | +| [printStackTrace](../-invalid-signature-verifier-subscription-exception/index.md#-1769529168%2FFunctions%2F1451286739) | [androidJvm]
open fun [printStackTrace](../-invalid-signature-verifier-subscription-exception/index.md#-1769529168%2FFunctions%2F1451286739)()
open fun [printStackTrace](../-invalid-signature-verifier-subscription-exception/index.md#1841853697%2FFunctions%2F1451286739)(p0: [PrintStream](https://developer.android.com/reference/kotlin/java/io/PrintStream.html))
open fun [printStackTrace](../-invalid-signature-verifier-subscription-exception/index.md#1175535278%2FFunctions%2F1451286739)(p0: [PrintWriter](https://developer.android.com/reference/kotlin/java/io/PrintWriter.html)) | +| [setStackTrace](../-invalid-signature-verifier-subscription-exception/index.md#2135801318%2FFunctions%2F1451286739) | [androidJvm]
open fun [setStackTrace](../-invalid-signature-verifier-subscription-exception/index.md#2135801318%2FFunctions%2F1451286739)(p0: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[StackTraceElement](https://developer.android.com/reference/kotlin/java/lang/StackTraceElement.html)>) | + +## Properties + +| Name | Summary | +|---|---| +| [cause](../-invalid-signature-verifier-subscription-exception/index.md#-654012527%2FProperties%2F1451286739) | [androidJvm]
open val [cause](../-invalid-signature-verifier-subscription-exception/index.md#-654012527%2FProperties%2F1451286739): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? | +| [message](../-invalid-signature-verifier-subscription-exception/index.md#1824300659%2FProperties%2F1451286739) | [androidJvm]
open val [message](../-invalid-signature-verifier-subscription-exception/index.md#1824300659%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/-invalid-signature-verifier-subscription-exception.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/-invalid-signature-verifier-subscription-exception.md new file mode 100644 index 000000000..f230bd7dd --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/-invalid-signature-verifier-subscription-exception.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.signatureverifier.api](../index.md)/[InvalidSignatureVerifierSubscriptionException](index.md)/[InvalidSignatureVerifierSubscriptionException](-invalid-signature-verifier-subscription-exception.md) + +# InvalidSignatureVerifierSubscriptionException + +[androidJvm]\ +fun [InvalidSignatureVerifierSubscriptionException](-invalid-signature-verifier-subscription-exception.md)() diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md new file mode 100644 index 000000000..49c618662 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md @@ -0,0 +1,34 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.signatureverifier.api](../index.md)/[InvalidSignatureVerifierSubscriptionException](index.md) + +# InvalidSignatureVerifierSubscriptionException + +[androidJvm]\ +class [InvalidSignatureVerifierSubscriptionException](index.md) : [IllegalArgumentException](https://developer.android.com/reference/kotlin/java/lang/IllegalArgumentException.html) + +Exception thrown when subscription key is not a valid. + +## Constructors + +| | | +|---|---| +| [InvalidSignatureVerifierSubscriptionException](-invalid-signature-verifier-subscription-exception.md) | [androidJvm]
fun [InvalidSignatureVerifierSubscriptionException](-invalid-signature-verifier-subscription-exception.md)() | + +## Functions + +| Name | Summary | +|---|---| +| [addSuppressed](index.md#282858770%2FFunctions%2F1451286739) | [androidJvm]
fun [addSuppressed](index.md#282858770%2FFunctions%2F1451286739)(p0: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) | +| [fillInStackTrace](index.md#-1102069925%2FFunctions%2F1451286739) | [androidJvm]
open fun [fillInStackTrace](index.md#-1102069925%2FFunctions%2F1451286739)(): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) | +| [getLocalizedMessage](index.md#1043865560%2FFunctions%2F1451286739) | [androidJvm]
open fun [getLocalizedMessage](index.md#1043865560%2FFunctions%2F1451286739)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [getStackTrace](index.md#2050903719%2FFunctions%2F1451286739) | [androidJvm]
open fun [getStackTrace](index.md#2050903719%2FFunctions%2F1451286739)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[StackTraceElement](https://developer.android.com/reference/kotlin/java/lang/StackTraceElement.html)> | +| [getSuppressed](index.md#672492560%2FFunctions%2F1451286739) | [androidJvm]
fun [getSuppressed](index.md#672492560%2FFunctions%2F1451286739)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)> | +| [initCause](index.md#-418225042%2FFunctions%2F1451286739) | [androidJvm]
open fun [initCause](index.md#-418225042%2FFunctions%2F1451286739)(p0: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) | +| [printStackTrace](index.md#-1769529168%2FFunctions%2F1451286739) | [androidJvm]
open fun [printStackTrace](index.md#-1769529168%2FFunctions%2F1451286739)()
open fun [printStackTrace](index.md#1841853697%2FFunctions%2F1451286739)(p0: [PrintStream](https://developer.android.com/reference/kotlin/java/io/PrintStream.html))
open fun [printStackTrace](index.md#1175535278%2FFunctions%2F1451286739)(p0: [PrintWriter](https://developer.android.com/reference/kotlin/java/io/PrintWriter.html)) | +| [setStackTrace](index.md#2135801318%2FFunctions%2F1451286739) | [androidJvm]
open fun [setStackTrace](index.md#2135801318%2FFunctions%2F1451286739)(p0: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[StackTraceElement](https://developer.android.com/reference/kotlin/java/lang/StackTraceElement.html)>) | + +## Properties + +| Name | Summary | +|---|---| +| [cause](index.md#-654012527%2FProperties%2F1451286739) | [androidJvm]
open val [cause](index.md#-654012527%2FProperties%2F1451286739): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? | +| [message](index.md#1824300659%2FProperties%2F1451286739) | [androidJvm]
open val [message](index.md#1824300659%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.signatureverifier.api/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.signatureverifier.api/index.md new file mode 100644 index 000000000..145a384e1 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.signatureverifier.api/index.md @@ -0,0 +1,10 @@ +//[miniapp](../../index.md)/[com.rakuten.tech.mobile.miniapp.signatureverifier.api](index.md) + +# Package com.rakuten.tech.mobile.miniapp.signatureverifier.api + +## Types + +| Name | Summary | +|---|---| +| [InvalidSignatureVerifierBaseUrlException](-invalid-signature-verifier-base-url-exception/index.md) | [androidJvm]
class [InvalidSignatureVerifierBaseUrlException](-invalid-signature-verifier-base-url-exception/index.md)(exception: [IllegalArgumentException](https://developer.android.com/reference/kotlin/java/lang/IllegalArgumentException.html)) : [IllegalArgumentException](https://developer.android.com/reference/kotlin/java/lang/IllegalArgumentException.html)
Exception thrown when endpoint is not a valid URL. | +| [InvalidSignatureVerifierSubscriptionException](-invalid-signature-verifier-subscription-exception/index.md) | [androidJvm]
class [InvalidSignatureVerifierSubscriptionException](-invalid-signature-verifier-subscription-exception/index.md) : [IllegalArgumentException](https://developer.android.com/reference/kotlin/java/lang/IllegalArgumentException.html)
Exception thrown when subscription key is not a valid. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-config/-mini-app-config.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-config/-mini-app-config.md new file mode 100644 index 000000000..c9d231f39 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-config/-mini-app-config.md @@ -0,0 +1,18 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.view](../index.md)/[MiniAppConfig](index.md)/[MiniAppConfig](-mini-app-config.md) + +# MiniAppConfig + +[androidJvm]\ +fun [MiniAppConfig](-mini-app-config.md)(miniAppSdkConfig: [MiniAppSdkConfig](../../com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/index.md), miniAppMessageBridge: [MiniAppMessageBridge](../../com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/index.md), miniAppNavigator: [MiniAppNavigator](../../com.rakuten.tech.mobile.miniapp.navigator/-mini-app-navigator/index.md)?, miniAppFileChooser: [MiniAppFileChooser](../../com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser/index.md)?, queryParams: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = "") + +## Parameters + +androidJvm + +| | | +|---|---| +| miniAppSdkConfig | configuration for Mini App SDK. | +| miniAppMessageBridge | the interface for communicating between host app & mini app. | +| miniAppNavigator | allow host app to handle specific urls such as external link. | +| miniAppFileChooser | allow host app to get the file path while choosing file inside the webview. | +| queryParams | the parameters will be appended with the miniapp url scheme. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-config/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-config/index.md new file mode 100644 index 000000000..31becc094 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-config/index.md @@ -0,0 +1,36 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.view](../index.md)/[MiniAppConfig](index.md) + +# MiniAppConfig + +[androidJvm]\ +data class [MiniAppConfig](index.md)(miniAppSdkConfig: [MiniAppSdkConfig](../../com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/index.md), miniAppMessageBridge: [MiniAppMessageBridge](../../com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/index.md), miniAppNavigator: [MiniAppNavigator](../../com.rakuten.tech.mobile.miniapp.navigator/-mini-app-navigator/index.md)?, miniAppFileChooser: [MiniAppFileChooser](../../com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser/index.md)?, queryParams: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) + +This represents the configuration settings for the Mini App. + +## Parameters + +androidJvm + +| | | +|---|---| +| miniAppSdkConfig | configuration for Mini App SDK. | +| miniAppMessageBridge | the interface for communicating between host app & mini app. | +| miniAppNavigator | allow host app to handle specific urls such as external link. | +| miniAppFileChooser | allow host app to get the file path while choosing file inside the webview. | +| queryParams | the parameters will be appended with the miniapp url scheme. | + +## Constructors + +| | | +|---|---| +| [MiniAppConfig](-mini-app-config.md) | [androidJvm]
fun [MiniAppConfig](-mini-app-config.md)(miniAppSdkConfig: [MiniAppSdkConfig](../../com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/index.md), miniAppMessageBridge: [MiniAppMessageBridge](../../com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/index.md), miniAppNavigator: [MiniAppNavigator](../../com.rakuten.tech.mobile.miniapp.navigator/-mini-app-navigator/index.md)?, miniAppFileChooser: [MiniAppFileChooser](../../com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser/index.md)?, queryParams: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = "") | + +## Properties + +| Name | Summary | +|---|---| +| [miniAppFileChooser](mini-app-file-chooser.md) | [androidJvm]
val [miniAppFileChooser](mini-app-file-chooser.md): [MiniAppFileChooser](../../com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser/index.md)? | +| [miniAppMessageBridge](mini-app-message-bridge.md) | [androidJvm]
val [miniAppMessageBridge](mini-app-message-bridge.md): [MiniAppMessageBridge](../../com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/index.md) | +| [miniAppNavigator](mini-app-navigator.md) | [androidJvm]
val [miniAppNavigator](mini-app-navigator.md): [MiniAppNavigator](../../com.rakuten.tech.mobile.miniapp.navigator/-mini-app-navigator/index.md)? | +| [miniAppSdkConfig](mini-app-sdk-config.md) | [androidJvm]
val [miniAppSdkConfig](mini-app-sdk-config.md): [MiniAppSdkConfig](../../com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/index.md) | +| [queryParams](query-params.md) | [androidJvm]
var [queryParams](query-params.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-config/mini-app-file-chooser.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-config/mini-app-file-chooser.md new file mode 100644 index 000000000..cacf56c9d --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-config/mini-app-file-chooser.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.view](../index.md)/[MiniAppConfig](index.md)/[miniAppFileChooser](mini-app-file-chooser.md) + +# miniAppFileChooser + +[androidJvm]\ +val [miniAppFileChooser](mini-app-file-chooser.md): [MiniAppFileChooser](../../com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser/index.md)? diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-config/mini-app-message-bridge.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-config/mini-app-message-bridge.md new file mode 100644 index 000000000..d99bb5865 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-config/mini-app-message-bridge.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.view](../index.md)/[MiniAppConfig](index.md)/[miniAppMessageBridge](mini-app-message-bridge.md) + +# miniAppMessageBridge + +[androidJvm]\ +val [miniAppMessageBridge](mini-app-message-bridge.md): [MiniAppMessageBridge](../../com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/index.md) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-config/mini-app-navigator.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-config/mini-app-navigator.md new file mode 100644 index 000000000..7ccc1f643 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-config/mini-app-navigator.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.view](../index.md)/[MiniAppConfig](index.md)/[miniAppNavigator](mini-app-navigator.md) + +# miniAppNavigator + +[androidJvm]\ +val [miniAppNavigator](mini-app-navigator.md): [MiniAppNavigator](../../com.rakuten.tech.mobile.miniapp.navigator/-mini-app-navigator/index.md)? diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-config/mini-app-sdk-config.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-config/mini-app-sdk-config.md new file mode 100644 index 000000000..d0d525454 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-config/mini-app-sdk-config.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.view](../index.md)/[MiniAppConfig](index.md)/[miniAppSdkConfig](mini-app-sdk-config.md) + +# miniAppSdkConfig + +[androidJvm]\ +val [miniAppSdkConfig](mini-app-sdk-config.md): [MiniAppSdkConfig](../../com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/index.md) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-config/query-params.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-config/query-params.md new file mode 100644 index 000000000..0a0f2426a --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-config/query-params.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.view](../index.md)/[MiniAppConfig](index.md)/[queryParams](query-params.md) + +# queryParams + +[androidJvm]\ +var [queryParams](query-params.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-default-params/-default-params.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-default-params/-default-params.md new file mode 100644 index 000000000..5b5430212 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-default-params/-default-params.md @@ -0,0 +1,17 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.view](../../index.md)/[MiniAppParameters](../index.md)/[DefaultParams](index.md)/[DefaultParams](-default-params.md) + +# DefaultParams + +[androidJvm]\ +fun [DefaultParams](-default-params.md)(context: [Context](https://developer.android.com/reference/kotlin/android/content/Context.html), config: [MiniAppConfig](../../-mini-app-config/index.md), miniAppId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), miniAppVersion: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), fromCache: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false) + +## Parameters + +androidJvm + +| | | +|---|---| +| context | is used by the view for initializing the internal services. Must be the context of activity to ensure that all standard html components work properly. | +| config | provide the necessary configuration to provide an independent MiniApp. | +| miniAppId | mini app id. | +| fromCache | allow host app to load miniapp from cache. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-default-params/config.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-default-params/config.md new file mode 100644 index 000000000..9d85695b0 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-default-params/config.md @@ -0,0 +1,6 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.view](../../index.md)/[MiniAppParameters](../index.md)/[DefaultParams](index.md)/[config](config.md) + +# config + +[androidJvm]\ +val [config](config.md): [MiniAppConfig](../../-mini-app-config/index.md) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-default-params/context.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-default-params/context.md new file mode 100644 index 000000000..6a4cc5875 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-default-params/context.md @@ -0,0 +1,6 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.view](../../index.md)/[MiniAppParameters](../index.md)/[DefaultParams](index.md)/[context](context.md) + +# context + +[androidJvm]\ +val [context](context.md): [Context](https://developer.android.com/reference/kotlin/android/content/Context.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-default-params/from-cache.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-default-params/from-cache.md new file mode 100644 index 000000000..e153cdbb9 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-default-params/from-cache.md @@ -0,0 +1,6 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.view](../../index.md)/[MiniAppParameters](../index.md)/[DefaultParams](index.md)/[fromCache](from-cache.md) + +# fromCache + +[androidJvm]\ +var [fromCache](from-cache.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-default-params/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-default-params/index.md new file mode 100644 index 000000000..88bfba3af --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-default-params/index.md @@ -0,0 +1,35 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.view](../../index.md)/[MiniAppParameters](../index.md)/[DefaultParams](index.md) + +# DefaultParams + +[androidJvm]\ +data class [DefaultParams](index.md)(context: [Context](https://developer.android.com/reference/kotlin/android/content/Context.html), config: [MiniAppConfig](../../-mini-app-config/index.md), miniAppId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), miniAppVersion: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), fromCache: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) : [MiniAppParameters](../index.md) + +This class can be used in the HostApp to create the mini app views using mini app id. + +## Parameters + +androidJvm + +| | | +|---|---| +| context | is used by the view for initializing the internal services. Must be the context of activity to ensure that all standard html components work properly. | +| config | provide the necessary configuration to provide an independent MiniApp. | +| miniAppId | mini app id. | +| fromCache | allow host app to load miniapp from cache. | + +## Constructors + +| | | +|---|---| +| [DefaultParams](-default-params.md) | [androidJvm]
fun [DefaultParams](-default-params.md)(context: [Context](https://developer.android.com/reference/kotlin/android/content/Context.html), config: [MiniAppConfig](../../-mini-app-config/index.md), miniAppId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), miniAppVersion: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), fromCache: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false) | + +## Properties + +| Name | Summary | +|---|---| +| [config](config.md) | [androidJvm]
val [config](config.md): [MiniAppConfig](../../-mini-app-config/index.md) | +| [context](context.md) | [androidJvm]
val [context](context.md): [Context](https://developer.android.com/reference/kotlin/android/content/Context.html) | +| [fromCache](from-cache.md) | [androidJvm]
var [fromCache](from-cache.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false | +| [miniAppId](mini-app-id.md) | [androidJvm]
val [miniAppId](mini-app-id.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [miniAppVersion](mini-app-version.md) | [androidJvm]
val [miniAppVersion](mini-app-version.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-default-params/mini-app-id.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-default-params/mini-app-id.md new file mode 100644 index 000000000..0ddbb58ca --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-default-params/mini-app-id.md @@ -0,0 +1,6 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.view](../../index.md)/[MiniAppParameters](../index.md)/[DefaultParams](index.md)/[miniAppId](mini-app-id.md) + +# miniAppId + +[androidJvm]\ +val [miniAppId](mini-app-id.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-default-params/mini-app-version.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-default-params/mini-app-version.md new file mode 100644 index 000000000..01040d4bb --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-default-params/mini-app-version.md @@ -0,0 +1,6 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.view](../../index.md)/[MiniAppParameters](../index.md)/[DefaultParams](index.md)/[miniAppVersion](mini-app-version.md) + +# miniAppVersion + +[androidJvm]\ +val [miniAppVersion](mini-app-version.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-info-params/-info-params.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-info-params/-info-params.md new file mode 100644 index 000000000..66ebd1572 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-info-params/-info-params.md @@ -0,0 +1,17 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.view](../../index.md)/[MiniAppParameters](../index.md)/[InfoParams](index.md)/[InfoParams](-info-params.md) + +# InfoParams + +[androidJvm]\ +fun [InfoParams](-info-params.md)(context: [Context](https://developer.android.com/reference/kotlin/android/content/Context.html), config: [MiniAppConfig](../../-mini-app-config/index.md), miniAppInfo: [MiniAppInfo](../../../com.rakuten.tech.mobile.miniapp/-mini-app-info/index.md), fromCache: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false) + +## Parameters + +androidJvm + +| | | +|---|---| +| context | is used by the view for initializing the internal services. Must be the context of activity to ensure that all standard html components work properly. | +| config | provide the necessary configuration to provide an independent MiniApp. | +| miniAppInfo | metadata of a mini app. | +| fromCache | allow host app to load miniapp from cache. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-info-params/config.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-info-params/config.md new file mode 100644 index 000000000..f67be5735 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-info-params/config.md @@ -0,0 +1,6 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.view](../../index.md)/[MiniAppParameters](../index.md)/[InfoParams](index.md)/[config](config.md) + +# config + +[androidJvm]\ +val [config](config.md): [MiniAppConfig](../../-mini-app-config/index.md) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-info-params/context.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-info-params/context.md new file mode 100644 index 000000000..4787c06cd --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-info-params/context.md @@ -0,0 +1,6 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.view](../../index.md)/[MiniAppParameters](../index.md)/[InfoParams](index.md)/[context](context.md) + +# context + +[androidJvm]\ +val [context](context.md): [Context](https://developer.android.com/reference/kotlin/android/content/Context.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-info-params/from-cache.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-info-params/from-cache.md new file mode 100644 index 000000000..4b3140e5a --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-info-params/from-cache.md @@ -0,0 +1,6 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.view](../../index.md)/[MiniAppParameters](../index.md)/[InfoParams](index.md)/[fromCache](from-cache.md) + +# fromCache + +[androidJvm]\ +var [fromCache](from-cache.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-info-params/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-info-params/index.md new file mode 100644 index 000000000..261a1c7eb --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-info-params/index.md @@ -0,0 +1,34 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.view](../../index.md)/[MiniAppParameters](../index.md)/[InfoParams](index.md) + +# InfoParams + +[androidJvm]\ +data class [InfoParams](index.md)(context: [Context](https://developer.android.com/reference/kotlin/android/content/Context.html), config: [MiniAppConfig](../../-mini-app-config/index.md), miniAppInfo: [MiniAppInfo](../../../com.rakuten.tech.mobile.miniapp/-mini-app-info/index.md), fromCache: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) : [MiniAppParameters](../index.md) + +This class can be used in the HostApp to create the mini app views using mini app id. + +## Parameters + +androidJvm + +| | | +|---|---| +| context | is used by the view for initializing the internal services. Must be the context of activity to ensure that all standard html components work properly. | +| config | provide the necessary configuration to provide an independent MiniApp. | +| miniAppInfo | metadata of a mini app. | +| fromCache | allow host app to load miniapp from cache. | + +## Constructors + +| | | +|---|---| +| [InfoParams](-info-params.md) | [androidJvm]
fun [InfoParams](-info-params.md)(context: [Context](https://developer.android.com/reference/kotlin/android/content/Context.html), config: [MiniAppConfig](../../-mini-app-config/index.md), miniAppInfo: [MiniAppInfo](../../../com.rakuten.tech.mobile.miniapp/-mini-app-info/index.md), fromCache: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false) | + +## Properties + +| Name | Summary | +|---|---| +| [config](config.md) | [androidJvm]
val [config](config.md): [MiniAppConfig](../../-mini-app-config/index.md) | +| [context](context.md) | [androidJvm]
val [context](context.md): [Context](https://developer.android.com/reference/kotlin/android/content/Context.html) | +| [fromCache](from-cache.md) | [androidJvm]
var [fromCache](from-cache.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false | +| [miniAppInfo](mini-app-info.md) | [androidJvm]
val [miniAppInfo](mini-app-info.md): [MiniAppInfo](../../../com.rakuten.tech.mobile.miniapp/-mini-app-info/index.md) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-info-params/mini-app-info.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-info-params/mini-app-info.md new file mode 100644 index 000000000..3e45c3982 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-info-params/mini-app-info.md @@ -0,0 +1,6 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.view](../../index.md)/[MiniAppParameters](../index.md)/[InfoParams](index.md)/[miniAppInfo](mini-app-info.md) + +# miniAppInfo + +[androidJvm]\ +val [miniAppInfo](mini-app-info.md): [MiniAppInfo](../../../com.rakuten.tech.mobile.miniapp/-mini-app-info/index.md) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-url-params/-url-params.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-url-params/-url-params.md new file mode 100644 index 000000000..97d8ef0db --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-url-params/-url-params.md @@ -0,0 +1,16 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.view](../../index.md)/[MiniAppParameters](../index.md)/[UrlParams](index.md)/[UrlParams](-url-params.md) + +# UrlParams + +[androidJvm]\ +fun [UrlParams](-url-params.md)(context: [Context](https://developer.android.com/reference/kotlin/android/content/Context.html), config: [MiniAppConfig](../../-mini-app-config/index.md), miniAppUrl: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) + +## Parameters + +androidJvm + +| | | +|---|---| +| context | is used by the view for initializing the internal services. Must be the context of activity to ensure that all standard html components work properly. | +| config | provide the necessary configuration to provide an independent MiniApp. Mini app is NOT downloaded and cached in local, its content are read directly from the url. This should only be used for previewing a mini app from a local server. | +| miniAppUrl | a HTTP url containing Mini App content. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-url-params/config.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-url-params/config.md new file mode 100644 index 000000000..7495e4b9d --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-url-params/config.md @@ -0,0 +1,6 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.view](../../index.md)/[MiniAppParameters](../index.md)/[UrlParams](index.md)/[config](config.md) + +# config + +[androidJvm]\ +val [config](config.md): [MiniAppConfig](../../-mini-app-config/index.md) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-url-params/context.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-url-params/context.md new file mode 100644 index 000000000..29b429452 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-url-params/context.md @@ -0,0 +1,6 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.view](../../index.md)/[MiniAppParameters](../index.md)/[UrlParams](index.md)/[context](context.md) + +# context + +[androidJvm]\ +val [context](context.md): [Context](https://developer.android.com/reference/kotlin/android/content/Context.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-url-params/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-url-params/index.md new file mode 100644 index 000000000..5bb50e295 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-url-params/index.md @@ -0,0 +1,32 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.view](../../index.md)/[MiniAppParameters](../index.md)/[UrlParams](index.md) + +# UrlParams + +[androidJvm]\ +data class [UrlParams](index.md)(context: [Context](https://developer.android.com/reference/kotlin/android/content/Context.html), config: [MiniAppConfig](../../-mini-app-config/index.md), miniAppUrl: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) : [MiniAppParameters](../index.md) + +This class can be used in the HostApp to create the mini app views using provided url. + +## Parameters + +androidJvm + +| | | +|---|---| +| context | is used by the view for initializing the internal services. Must be the context of activity to ensure that all standard html components work properly. | +| config | provide the necessary configuration to provide an independent MiniApp. Mini app is NOT downloaded and cached in local, its content are read directly from the url. This should only be used for previewing a mini app from a local server. | +| miniAppUrl | a HTTP url containing Mini App content. | + +## Constructors + +| | | +|---|---| +| [UrlParams](-url-params.md) | [androidJvm]
fun [UrlParams](-url-params.md)(context: [Context](https://developer.android.com/reference/kotlin/android/content/Context.html), config: [MiniAppConfig](../../-mini-app-config/index.md), miniAppUrl: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) | + +## Properties + +| Name | Summary | +|---|---| +| [config](config.md) | [androidJvm]
val [config](config.md): [MiniAppConfig](../../-mini-app-config/index.md) | +| [context](context.md) | [androidJvm]
val [context](context.md): [Context](https://developer.android.com/reference/kotlin/android/content/Context.html) | +| [miniAppUrl](mini-app-url.md) | [androidJvm]
val [miniAppUrl](mini-app-url.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-url-params/mini-app-url.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-url-params/mini-app-url.md new file mode 100644 index 000000000..ab8dc5dbc --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-url-params/mini-app-url.md @@ -0,0 +1,6 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.view](../../index.md)/[MiniAppParameters](../index.md)/[UrlParams](index.md)/[miniAppUrl](mini-app-url.md) + +# miniAppUrl + +[androidJvm]\ +val [miniAppUrl](mini-app-url.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/index.md new file mode 100644 index 000000000..293241cad --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/index.md @@ -0,0 +1,24 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.view](../index.md)/[MiniAppParameters](index.md) + +# MiniAppParameters + +[androidJvm]\ +sealed class [MiniAppParameters](index.md) + +This class can be used in the HostApp to create the mini app views using mini app id. + +## Types + +| Name | Summary | +|---|---| +| [DefaultParams](-default-params/index.md) | [androidJvm]
data class [DefaultParams](-default-params/index.md)(context: [Context](https://developer.android.com/reference/kotlin/android/content/Context.html), config: [MiniAppConfig](../-mini-app-config/index.md), miniAppId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), miniAppVersion: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), fromCache: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) : [MiniAppParameters](index.md)
This class can be used in the HostApp to create the mini app views using mini app id. | +| [InfoParams](-info-params/index.md) | [androidJvm]
data class [InfoParams](-info-params/index.md)(context: [Context](https://developer.android.com/reference/kotlin/android/content/Context.html), config: [MiniAppConfig](../-mini-app-config/index.md), miniAppInfo: [MiniAppInfo](../../com.rakuten.tech.mobile.miniapp/-mini-app-info/index.md), fromCache: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) : [MiniAppParameters](index.md)
This class can be used in the HostApp to create the mini app views using mini app id. | +| [UrlParams](-url-params/index.md) | [androidJvm]
data class [UrlParams](-url-params/index.md)(context: [Context](https://developer.android.com/reference/kotlin/android/content/Context.html), config: [MiniAppConfig](../-mini-app-config/index.md), miniAppUrl: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) : [MiniAppParameters](index.md)
This class can be used in the HostApp to create the mini app views using provided url. | + +## Inheritors + +| Name | +|---| +| [DefaultParams](-default-params/index.md) | +| [InfoParams](-info-params/index.md) | +| [UrlParams](-url-params/index.md) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-view/-companion/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-view/-companion/index.md new file mode 100644 index 000000000..338340232 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-view/-companion/index.md @@ -0,0 +1,12 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.view](../../index.md)/[MiniAppView](../index.md)/[Companion](index.md) + +# Companion + +[androidJvm]\ +object [Companion](index.md) + +## Functions + +| Name | Summary | +|---|---| +| [init](init.md) | [androidJvm]
fun [init](init.md)(miniAppParameters: [MiniAppParameters](../../-mini-app-parameters/index.md)): [MiniAppView](../index.md)
initialize a mini app view. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-view/-companion/init.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-view/-companion/init.md new file mode 100644 index 000000000..3c9c063d1 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-view/-companion/init.md @@ -0,0 +1,16 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp.view](../../index.md)/[MiniAppView](../index.md)/[Companion](index.md)/[init](init.md) + +# init + +[androidJvm]\ +fun [init](init.md)(miniAppParameters: [MiniAppParameters](../../-mini-app-parameters/index.md)): [MiniAppView](../index.md) + +initialize a mini app view. + +## Parameters + +androidJvm + +| | | +|---|---| +| miniAppParameters | parameters needed to create a mini app. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-view/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-view/index.md new file mode 100644 index 000000000..439315e62 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-view/index.md @@ -0,0 +1,22 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.view](../index.md)/[MiniAppView](index.md) + +# MiniAppView + +[androidJvm]\ +abstract class [MiniAppView](index.md) + +This class can be used in the HostApp to create the miniapp views independently. + +## Types + +| Name | Summary | +|---|---| +| [Companion](-companion/index.md) | [androidJvm]
object [Companion](-companion/index.md) | + +## Functions + +| Name | Summary | +|---|---| +| [load](load.md) | [androidJvm]
abstract fun [load](load.md)(queryParams: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = "", fromCache: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false, onComplete: ([MiniAppDisplay](../../com.rakuten.tech.mobile.miniapp/-mini-app-display/index.md)?, [MiniAppSdkException](../../com.rakuten.tech.mobile.miniapp/-mini-app-sdk-exception/index.md)?) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
load a mini app view. The mini app is downloaded, saved and provides a view when successful. | +| [loadFromBundle](load-from-bundle.md) | [androidJvm]
abstract fun [loadFromBundle](load-from-bundle.md)(manifest: [MiniAppManifest](../../com.rakuten.tech.mobile.miniapp/-mini-app-manifest/index.md)? = null, onComplete: ([MiniAppDisplay](../../com.rakuten.tech.mobile.miniapp/-mini-app-display/index.md)?, [MiniAppSdkException](../../com.rakuten.tech.mobile.miniapp/-mini-app-sdk-exception/index.md)?) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
load a mini app view from bundle. The mini app is downloaded, saved and provides a view when successful. | +| [sendJsonToMiniApp](send-json-to-mini-app.md) | [androidJvm]
abstract fun [sendJsonToMiniApp](send-json-to-mini-app.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), onFailed: () -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
Send a generic message to MiniApp using [com.rakuten.tech.mobile.miniapp.js.NativeEventType.MINIAPP_RECEIVE_JSON_INFO](../../com.rakuten.tech.mobile.miniapp.js/-native-event-type/-m-i-n-i-a-p-p_-r-e-c-e-i-v-e_-j-s-o-n_-i-n-f-o/index.md). | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-view/load-from-bundle.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-view/load-from-bundle.md new file mode 100644 index 000000000..ba129cfeb --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-view/load-from-bundle.md @@ -0,0 +1,17 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.view](../index.md)/[MiniAppView](index.md)/[loadFromBundle](load-from-bundle.md) + +# loadFromBundle + +[androidJvm]\ +abstract fun [loadFromBundle](load-from-bundle.md)(manifest: [MiniAppManifest](../../com.rakuten.tech.mobile.miniapp/-mini-app-manifest/index.md)? = null, onComplete: ([MiniAppDisplay](../../com.rakuten.tech.mobile.miniapp/-mini-app-display/index.md)?, [MiniAppSdkException](../../com.rakuten.tech.mobile.miniapp/-mini-app-sdk-exception/index.md)?) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) + +load a mini app view from bundle. The mini app is downloaded, saved and provides a view when successful. + +## Parameters + +androidJvm + +| | | +|---|---| +| manifest | the parameters will be appended with the miniapp manifest. | +| onComplete | parameters needed to callback when the miniapp is successfully loaded. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-view/load.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-view/load.md new file mode 100644 index 000000000..43b21baa6 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-view/load.md @@ -0,0 +1,18 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.view](../index.md)/[MiniAppView](index.md)/[load](load.md) + +# load + +[androidJvm]\ +abstract fun [load](load.md)(queryParams: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = "", fromCache: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false, onComplete: ([MiniAppDisplay](../../com.rakuten.tech.mobile.miniapp/-mini-app-display/index.md)?, [MiniAppSdkException](../../com.rakuten.tech.mobile.miniapp/-mini-app-sdk-exception/index.md)?) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) + +load a mini app view. The mini app is downloaded, saved and provides a view when successful. + +## Parameters + +androidJvm + +| | | +|---|---| +| queryParams | the parameters will be appended with the miniapp url scheme. | +| fromCache | the parameters will be appended with cached miniapp. | +| onComplete | parameters needed to callback when the miniapp is successfully loaded. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-view/send-json-to-mini-app.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-view/send-json-to-mini-app.md new file mode 100644 index 000000000..a92a7b9c8 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-view/send-json-to-mini-app.md @@ -0,0 +1,17 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp.view](../index.md)/[MiniAppView](index.md)/[sendJsonToMiniApp](send-json-to-mini-app.md) + +# sendJsonToMiniApp + +[androidJvm]\ +abstract fun [sendJsonToMiniApp](send-json-to-mini-app.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), onFailed: () -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) + +Send a generic message to MiniApp using [com.rakuten.tech.mobile.miniapp.js.NativeEventType.MINIAPP_RECEIVE_JSON_INFO](../../com.rakuten.tech.mobile.miniapp.js/-native-event-type/-m-i-n-i-a-p-p_-r-e-c-e-i-v-e_-j-s-o-n_-i-n-f-o/index.md). + +## Parameters + +androidJvm + +| | | +|---|---| +| message | the content that will send to the MiniApp | +| onFailed | invoked when the validation does not pass to send the message | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/index.md new file mode 100644 index 000000000..4a76fd824 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp.view/index.md @@ -0,0 +1,11 @@ +//[miniapp](../../index.md)/[com.rakuten.tech.mobile.miniapp.view](index.md) + +# Package com.rakuten.tech.mobile.miniapp.view + +## Types + +| Name | Summary | +|---|---| +| [MiniAppConfig](-mini-app-config/index.md) | [androidJvm]
data class [MiniAppConfig](-mini-app-config/index.md)(miniAppSdkConfig: [MiniAppSdkConfig](../com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/index.md), miniAppMessageBridge: [MiniAppMessageBridge](../com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/index.md), miniAppNavigator: [MiniAppNavigator](../com.rakuten.tech.mobile.miniapp.navigator/-mini-app-navigator/index.md)?, miniAppFileChooser: [MiniAppFileChooser](../com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser/index.md)?, queryParams: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html))
This represents the configuration settings for the Mini App. | +| [MiniAppParameters](-mini-app-parameters/index.md) | [androidJvm]
sealed class [MiniAppParameters](-mini-app-parameters/index.md)
This class can be used in the HostApp to create the mini app views using mini app id. | +| [MiniAppView](-mini-app-view/index.md) | [androidJvm]
abstract class [MiniAppView](-mini-app-view/index.md)
This class can be used in the HostApp to create the miniapp views independently. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-host/-host.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-host/-host.md new file mode 100644 index 000000000..bb8d5292f --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-host/-host.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[Host](index.md)/[Host](-host.md) + +# Host + +[androidJvm]\ +fun [Host](-host.md)(id: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), subscriptionKey: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-host/id.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-host/id.md new file mode 100644 index 000000000..a7b85c537 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-host/id.md @@ -0,0 +1,9 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[Host](index.md)/[id](id.md) + +# id + +[androidJvm]\ + +@SerializedName(value = "id") + +val [id](id.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-host/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-host/index.md new file mode 100644 index 000000000..e2d3de6b1 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-host/index.md @@ -0,0 +1,28 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[Host](index.md) + +# Host + +[androidJvm]\ +data class [Host](index.md)(id: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), subscriptionKey: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) : [Parcelable](https://developer.android.com/reference/kotlin/android/os/Parcelable.html) + +This represents a host entity of a Mini App. + +## Constructors + +| | | +|---|---| +| [Host](-host.md) | [androidJvm]
fun [Host](-host.md)(id: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), subscriptionKey: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) | + +## Functions + +| Name | Summary | +|---|---| +| [describeContents](../../com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/index.md#-1578325224%2FFunctions%2F1451286739) | [androidJvm]
abstract fun [describeContents](../../com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/index.md#-1578325224%2FFunctions%2F1451286739)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [writeToParcel](../../com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/index.md#-1754457655%2FFunctions%2F1451286739) | [androidJvm]
abstract fun [writeToParcel](../../com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/index.md#-1754457655%2FFunctions%2F1451286739)(p0: [Parcel](https://developer.android.com/reference/kotlin/android/os/Parcel.html), p1: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) | + +## Properties + +| Name | Summary | +|---|---| +| [id](id.md) | [androidJvm]
@SerializedName(value = "id")
val [id](id.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
host id information of the mini app. | +| [subscriptionKey](subscription-key.md) | [androidJvm]
@SerializedName(value = "subscriptionKey")
val [subscriptionKey](subscription-key.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
subscription identifier of the mini app. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-host/subscription-key.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-host/subscription-key.md new file mode 100644 index 000000000..82236f91b --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-host/subscription-key.md @@ -0,0 +1,9 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[Host](index.md)/[subscriptionKey](subscription-key.md) + +# subscriptionKey + +[androidJvm]\ + +@SerializedName(value = "subscriptionKey") + +val [subscriptionKey](subscription-key.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-invalid-mini-app-info-exception/-invalid-mini-app-info-exception.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-invalid-mini-app-info-exception/-invalid-mini-app-info-exception.md new file mode 100644 index 000000000..bf7c85436 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-invalid-mini-app-info-exception/-invalid-mini-app-info-exception.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[InvalidMiniAppInfoException](index.md)/[InvalidMiniAppInfoException](-invalid-mini-app-info-exception.md) + +# InvalidMiniAppInfoException + +[androidJvm]\ +fun [InvalidMiniAppInfoException](-invalid-mini-app-info-exception.md)() diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-invalid-mini-app-info-exception/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-invalid-mini-app-info-exception/index.md new file mode 100644 index 000000000..8f71a607f --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-invalid-mini-app-info-exception/index.md @@ -0,0 +1,34 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[InvalidMiniAppInfoException](index.md) + +# InvalidMiniAppInfoException + +[androidJvm]\ +class [InvalidMiniAppInfoException](index.md) : [MiniAppSdkException](../-mini-app-sdk-exception/index.md) + +Exception which is thrown when the the appId or versionId is empty. + +## Constructors + +| | | +|---|---| +| [InvalidMiniAppInfoException](-invalid-mini-app-info-exception.md) | [androidJvm]
fun [InvalidMiniAppInfoException](-invalid-mini-app-info-exception.md)() | + +## Functions + +| Name | Summary | +|---|---| +| [addSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#282858770%2FFunctions%2F1451286739) | [androidJvm]
fun [addSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#282858770%2FFunctions%2F1451286739)(p0: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) | +| [fillInStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1102069925%2FFunctions%2F1451286739) | [androidJvm]
open fun [fillInStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1102069925%2FFunctions%2F1451286739)(): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) | +| [getLocalizedMessage](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1043865560%2FFunctions%2F1451286739) | [androidJvm]
open fun [getLocalizedMessage](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1043865560%2FFunctions%2F1451286739)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [getStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2050903719%2FFunctions%2F1451286739) | [androidJvm]
open fun [getStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2050903719%2FFunctions%2F1451286739)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[StackTraceElement](https://developer.android.com/reference/kotlin/java/lang/StackTraceElement.html)> | +| [getSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#672492560%2FFunctions%2F1451286739) | [androidJvm]
fun [getSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#672492560%2FFunctions%2F1451286739)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)> | +| [initCause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-418225042%2FFunctions%2F1451286739) | [androidJvm]
open fun [initCause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-418225042%2FFunctions%2F1451286739)(p0: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) | +| [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1769529168%2FFunctions%2F1451286739) | [androidJvm]
open fun [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1769529168%2FFunctions%2F1451286739)()
open fun [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1841853697%2FFunctions%2F1451286739)(p0: [PrintStream](https://developer.android.com/reference/kotlin/java/io/PrintStream.html))
open fun [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1175535278%2FFunctions%2F1451286739)(p0: [PrintWriter](https://developer.android.com/reference/kotlin/java/io/PrintWriter.html)) | +| [setStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2135801318%2FFunctions%2F1451286739) | [androidJvm]
open fun [setStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2135801318%2FFunctions%2F1451286739)(p0: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[StackTraceElement](https://developer.android.com/reference/kotlin/java/lang/StackTraceElement.html)>) | + +## Properties + +| Name | Summary | +|---|---| +| [cause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-654012527%2FProperties%2F1451286739) | [androidJvm]
open val [cause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-654012527%2FProperties%2F1451286739): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? | +| [message](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1824300659%2FProperties%2F1451286739) | [androidJvm]
open val [message](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1824300659%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-bundle-not-found-exception/-mini-app-bundle-not-found-exception.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-bundle-not-found-exception/-mini-app-bundle-not-found-exception.md new file mode 100644 index 000000000..2b612d2ed --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-bundle-not-found-exception/-mini-app-bundle-not-found-exception.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppBundleNotFoundException](index.md)/[MiniAppBundleNotFoundException](-mini-app-bundle-not-found-exception.md) + +# MiniAppBundleNotFoundException + +[androidJvm]\ +fun [MiniAppBundleNotFoundException](-mini-app-bundle-not-found-exception.md)() diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-bundle-not-found-exception/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-bundle-not-found-exception/index.md new file mode 100644 index 000000000..2ebb03470 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-bundle-not-found-exception/index.md @@ -0,0 +1,34 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppBundleNotFoundException](index.md) + +# MiniAppBundleNotFoundException + +[androidJvm]\ +class [MiniAppBundleNotFoundException](index.md) : [MiniAppSdkException](../-mini-app-sdk-exception/index.md) + +Exception which is thrown when the MiniApp Bundle is missing. + +## Constructors + +| | | +|---|---| +| [MiniAppBundleNotFoundException](-mini-app-bundle-not-found-exception.md) | [androidJvm]
fun [MiniAppBundleNotFoundException](-mini-app-bundle-not-found-exception.md)() | + +## Functions + +| Name | Summary | +|---|---| +| [addSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#282858770%2FFunctions%2F1451286739) | [androidJvm]
fun [addSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#282858770%2FFunctions%2F1451286739)(p0: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) | +| [fillInStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1102069925%2FFunctions%2F1451286739) | [androidJvm]
open fun [fillInStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1102069925%2FFunctions%2F1451286739)(): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) | +| [getLocalizedMessage](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1043865560%2FFunctions%2F1451286739) | [androidJvm]
open fun [getLocalizedMessage](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1043865560%2FFunctions%2F1451286739)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [getStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2050903719%2FFunctions%2F1451286739) | [androidJvm]
open fun [getStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2050903719%2FFunctions%2F1451286739)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[StackTraceElement](https://developer.android.com/reference/kotlin/java/lang/StackTraceElement.html)> | +| [getSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#672492560%2FFunctions%2F1451286739) | [androidJvm]
fun [getSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#672492560%2FFunctions%2F1451286739)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)> | +| [initCause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-418225042%2FFunctions%2F1451286739) | [androidJvm]
open fun [initCause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-418225042%2FFunctions%2F1451286739)(p0: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) | +| [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1769529168%2FFunctions%2F1451286739) | [androidJvm]
open fun [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1769529168%2FFunctions%2F1451286739)()
open fun [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1841853697%2FFunctions%2F1451286739)(p0: [PrintStream](https://developer.android.com/reference/kotlin/java/io/PrintStream.html))
open fun [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1175535278%2FFunctions%2F1451286739)(p0: [PrintWriter](https://developer.android.com/reference/kotlin/java/io/PrintWriter.html)) | +| [setStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2135801318%2FFunctions%2F1451286739) | [androidJvm]
open fun [setStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2135801318%2FFunctions%2F1451286739)(p0: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[StackTraceElement](https://developer.android.com/reference/kotlin/java/lang/StackTraceElement.html)>) | + +## Properties + +| Name | Summary | +|---|---| +| [cause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-654012527%2FProperties%2F1451286739) | [androidJvm]
open val [cause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-654012527%2FProperties%2F1451286739): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? | +| [message](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1824300659%2FProperties%2F1451286739) | [androidJvm]
open val [message](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1824300659%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-display/destroy-view.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-display/destroy-view.md new file mode 100644 index 000000000..f8175c90e --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-display/destroy-view.md @@ -0,0 +1,16 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppDisplay](index.md)/[destroyView](destroy-view.md) + +# destroyView + +[androidJvm]\ +abstract fun [destroyView](destroy-view.md)() + +Upon invocation, destroys necessary view state and any services registered with. When the consumer has finished consuming, it is advisable to release the resources. Usual scenarios are when the app components are amidst their destroy cycle. + +## See also + +androidJvm + +| | | +|---|---| +| link | [https://developer.android.com/topic/libraries/architecture/lifecycle#lc] on how to setup automatic clearing based on [LifecycleObserver](https://developer.android.com/reference/kotlin/androidx/lifecycle/LifecycleObserver.html) for usual scenarios. To be called when resources are managed manually or where consumer app has more control on the lifecycle of views e.g. removal of the view from the view system, yet within the same state of parent's lifecycle. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-display/get-mini-app-view.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-display/get-mini-app-view.md new file mode 100644 index 000000000..2ce96ec53 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-display/get-mini-app-view.md @@ -0,0 +1,26 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppDisplay](index.md)/[getMiniAppView](get-mini-app-view.md) + +# getMiniAppView + +[androidJvm]\ +abstract suspend fun [getMiniAppView](get-mini-app-view.md)(activityContext: [Context](https://developer.android.com/reference/kotlin/android/content/Context.html)): [View](https://developer.android.com/reference/kotlin/android/view/View.html)? + +Provides the view associated with the mini app to the caller for showing the mini app. + +#### Return + +[View](https://developer.android.com/reference/kotlin/android/view/View.html) as mini app's view with LayoutParams set to match the parent's dimensions. + +## Parameters + +androidJvm + +| | | +|---|---| +| activityContext | is used by the view for initializing the internal services. Must be the context of activity to ensure that all standard html components work properly. | + +## Throws + +| | | +|---|---| +| [com.rakuten.tech.mobile.miniapp.MiniAppSdkException](../-mini-app-sdk-exception/index.md) | when a non-matching context is supplied | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-display/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-display/index.md new file mode 100644 index 000000000..b9e3a645d --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-display/index.md @@ -0,0 +1,18 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppDisplay](index.md) + +# MiniAppDisplay + +[androidJvm]\ +interface [MiniAppDisplay](index.md) : [LifecycleObserver](https://developer.android.com/reference/kotlin/androidx/lifecycle/LifecycleObserver.html) + +This represents the contract by which the host app can interact with the display unit of the mini app. This contract complies to Android's [LifecycleObserver](https://developer.android.com/reference/kotlin/androidx/lifecycle/LifecycleObserver.html) contract, and when made to observe the lifecycle, it automatically clears up the view state and any services registered with. + +## Functions + +| Name | Summary | +|---|---| +| [destroyView](destroy-view.md) | [androidJvm]
abstract fun [destroyView](destroy-view.md)()
Upon invocation, destroys necessary view state and any services registered with. When the consumer has finished consuming, it is advisable to release the resources. Usual scenarios are when the app components are amidst their destroy cycle. | +| [getMiniAppView](get-mini-app-view.md) | [androidJvm]
abstract suspend fun [getMiniAppView](get-mini-app-view.md)(activityContext: [Context](https://developer.android.com/reference/kotlin/android/content/Context.html)): [View](https://developer.android.com/reference/kotlin/android/view/View.html)?
Provides the view associated with the mini app to the caller for showing the mini app. | +| [navigateBackward](navigate-backward.md) | [androidJvm]
abstract fun [navigateBackward](navigate-backward.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Navigates one level back, in the call stack, if possible. | +| [navigateForward](navigate-forward.md) | [androidJvm]
abstract fun [navigateForward](navigate-forward.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Navigates one level forward from current position, in the call hierarchy, if possible. | +| [sendJsonToMiniApp](send-json-to-mini-app.md) | [androidJvm]
abstract fun [sendJsonToMiniApp](send-json-to-mini-app.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html))
Send a generic message to MiniApp using [com.rakuten.tech.mobile.miniapp.js.NativeEventType.MINIAPP_RECEIVE_JSON_INFO](../../com.rakuten.tech.mobile.miniapp.js/-native-event-type/-m-i-n-i-a-p-p_-r-e-c-e-i-v-e_-j-s-o-n_-i-n-f-o/index.md). | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-display/navigate-backward.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-display/navigate-backward.md new file mode 100644 index 000000000..571959c49 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-display/navigate-backward.md @@ -0,0 +1,8 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppDisplay](index.md)/[navigateBackward](navigate-backward.md) + +# navigateBackward + +[androidJvm]\ +abstract fun [navigateBackward](navigate-backward.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Navigates one level back, in the call stack, if possible. diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-display/navigate-forward.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-display/navigate-forward.md new file mode 100644 index 000000000..de02ad8ee --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-display/navigate-forward.md @@ -0,0 +1,8 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppDisplay](index.md)/[navigateForward](navigate-forward.md) + +# navigateForward + +[androidJvm]\ +abstract fun [navigateForward](navigate-forward.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Navigates one level forward from current position, in the call hierarchy, if possible. diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-display/send-json-to-mini-app.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-display/send-json-to-mini-app.md new file mode 100644 index 000000000..0714755fe --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-display/send-json-to-mini-app.md @@ -0,0 +1,16 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppDisplay](index.md)/[sendJsonToMiniApp](send-json-to-mini-app.md) + +# sendJsonToMiniApp + +[androidJvm]\ +abstract fun [sendJsonToMiniApp](send-json-to-mini-app.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) + +Send a generic message to MiniApp using [com.rakuten.tech.mobile.miniapp.js.NativeEventType.MINIAPP_RECEIVE_JSON_INFO](../../com.rakuten.tech.mobile.miniapp.js/-native-event-type/-m-i-n-i-a-p-p_-r-e-c-e-i-v-e_-j-s-o-n_-i-n-f-o/index.md). + +## Parameters + +androidJvm + +| | | +|---|---| +| message | the content that will send to the MiniApp | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-has-corrupted-exception/-mini-app-has-corrupted-exception.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-has-corrupted-exception/-mini-app-has-corrupted-exception.md new file mode 100644 index 000000000..57ed60e61 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-has-corrupted-exception/-mini-app-has-corrupted-exception.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppHasCorruptedException](index.md)/[MiniAppHasCorruptedException](-mini-app-has-corrupted-exception.md) + +# MiniAppHasCorruptedException + +[androidJvm]\ +fun [MiniAppHasCorruptedException](-mini-app-has-corrupted-exception.md)(appId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-has-corrupted-exception/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-has-corrupted-exception/index.md new file mode 100644 index 000000000..089330208 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-has-corrupted-exception/index.md @@ -0,0 +1,34 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppHasCorruptedException](index.md) + +# MiniAppHasCorruptedException + +[androidJvm]\ +class [MiniAppHasCorruptedException](index.md)(appId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) : [MiniAppSdkException](../-mini-app-sdk-exception/index.md) + +Exception which is thrown when the MiniApp bundle is corrupted. + +## Constructors + +| | | +|---|---| +| [MiniAppHasCorruptedException](-mini-app-has-corrupted-exception.md) | [androidJvm]
fun [MiniAppHasCorruptedException](-mini-app-has-corrupted-exception.md)(appId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) | + +## Functions + +| Name | Summary | +|---|---| +| [addSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#282858770%2FFunctions%2F1451286739) | [androidJvm]
fun [addSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#282858770%2FFunctions%2F1451286739)(p0: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) | +| [fillInStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1102069925%2FFunctions%2F1451286739) | [androidJvm]
open fun [fillInStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1102069925%2FFunctions%2F1451286739)(): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) | +| [getLocalizedMessage](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1043865560%2FFunctions%2F1451286739) | [androidJvm]
open fun [getLocalizedMessage](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1043865560%2FFunctions%2F1451286739)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [getStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2050903719%2FFunctions%2F1451286739) | [androidJvm]
open fun [getStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2050903719%2FFunctions%2F1451286739)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[StackTraceElement](https://developer.android.com/reference/kotlin/java/lang/StackTraceElement.html)> | +| [getSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#672492560%2FFunctions%2F1451286739) | [androidJvm]
fun [getSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#672492560%2FFunctions%2F1451286739)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)> | +| [initCause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-418225042%2FFunctions%2F1451286739) | [androidJvm]
open fun [initCause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-418225042%2FFunctions%2F1451286739)(p0: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) | +| [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1769529168%2FFunctions%2F1451286739) | [androidJvm]
open fun [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1769529168%2FFunctions%2F1451286739)()
open fun [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1841853697%2FFunctions%2F1451286739)(p0: [PrintStream](https://developer.android.com/reference/kotlin/java/io/PrintStream.html))
open fun [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1175535278%2FFunctions%2F1451286739)(p0: [PrintWriter](https://developer.android.com/reference/kotlin/java/io/PrintWriter.html)) | +| [setStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2135801318%2FFunctions%2F1451286739) | [androidJvm]
open fun [setStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2135801318%2FFunctions%2F1451286739)(p0: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[StackTraceElement](https://developer.android.com/reference/kotlin/java/lang/StackTraceElement.html)>) | + +## Properties + +| Name | Summary | +|---|---| +| [cause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-654012527%2FProperties%2F1451286739) | [androidJvm]
open val [cause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-654012527%2FProperties%2F1451286739): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? | +| [message](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1824300659%2FProperties%2F1451286739) | [androidJvm]
open val [message](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1824300659%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-has-no-published-version-exception/-mini-app-has-no-published-version-exception.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-has-no-published-version-exception/-mini-app-has-no-published-version-exception.md new file mode 100644 index 000000000..39e9b5838 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-has-no-published-version-exception/-mini-app-has-no-published-version-exception.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppHasNoPublishedVersionException](index.md)/[MiniAppHasNoPublishedVersionException](-mini-app-has-no-published-version-exception.md) + +# MiniAppHasNoPublishedVersionException + +[androidJvm]\ +fun [MiniAppHasNoPublishedVersionException](-mini-app-has-no-published-version-exception.md)(appId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-has-no-published-version-exception/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-has-no-published-version-exception/index.md new file mode 100644 index 000000000..dee47d58b --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-has-no-published-version-exception/index.md @@ -0,0 +1,34 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppHasNoPublishedVersionException](index.md) + +# MiniAppHasNoPublishedVersionException + +[androidJvm]\ +class [MiniAppHasNoPublishedVersionException](index.md)(appId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) : [MiniAppSdkException](../-mini-app-sdk-exception/index.md) + +Exception which is thrown when the server returns no published versions for the provided mini app ID. + +## Constructors + +| | | +|---|---| +| [MiniAppHasNoPublishedVersionException](-mini-app-has-no-published-version-exception.md) | [androidJvm]
fun [MiniAppHasNoPublishedVersionException](-mini-app-has-no-published-version-exception.md)(appId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) | + +## Functions + +| Name | Summary | +|---|---| +| [addSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#282858770%2FFunctions%2F1451286739) | [androidJvm]
fun [addSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#282858770%2FFunctions%2F1451286739)(p0: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) | +| [fillInStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1102069925%2FFunctions%2F1451286739) | [androidJvm]
open fun [fillInStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1102069925%2FFunctions%2F1451286739)(): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) | +| [getLocalizedMessage](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1043865560%2FFunctions%2F1451286739) | [androidJvm]
open fun [getLocalizedMessage](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1043865560%2FFunctions%2F1451286739)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [getStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2050903719%2FFunctions%2F1451286739) | [androidJvm]
open fun [getStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2050903719%2FFunctions%2F1451286739)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[StackTraceElement](https://developer.android.com/reference/kotlin/java/lang/StackTraceElement.html)> | +| [getSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#672492560%2FFunctions%2F1451286739) | [androidJvm]
fun [getSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#672492560%2FFunctions%2F1451286739)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)> | +| [initCause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-418225042%2FFunctions%2F1451286739) | [androidJvm]
open fun [initCause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-418225042%2FFunctions%2F1451286739)(p0: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) | +| [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1769529168%2FFunctions%2F1451286739) | [androidJvm]
open fun [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1769529168%2FFunctions%2F1451286739)()
open fun [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1841853697%2FFunctions%2F1451286739)(p0: [PrintStream](https://developer.android.com/reference/kotlin/java/io/PrintStream.html))
open fun [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1175535278%2FFunctions%2F1451286739)(p0: [PrintWriter](https://developer.android.com/reference/kotlin/java/io/PrintWriter.html)) | +| [setStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2135801318%2FFunctions%2F1451286739) | [androidJvm]
open fun [setStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2135801318%2FFunctions%2F1451286739)(p0: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[StackTraceElement](https://developer.android.com/reference/kotlin/java/lang/StackTraceElement.html)>) | + +## Properties + +| Name | Summary | +|---|---| +| [cause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-654012527%2FProperties%2F1451286739) | [androidJvm]
open val [cause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-654012527%2FProperties%2F1451286739): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? | +| [message](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1824300659%2FProperties%2F1451286739) | [androidJvm]
open val [message](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1824300659%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-host-exception/-mini-app-host-exception.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-host-exception/-mini-app-host-exception.md new file mode 100644 index 000000000..93f0e3831 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-host-exception/-mini-app-host-exception.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppHostException](index.md)/[MiniAppHostException](-mini-app-host-exception.md) + +# MiniAppHostException + +[androidJvm]\ +fun [MiniAppHostException](-mini-app-host-exception.md)(serverMessage: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-host-exception/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-host-exception/index.md new file mode 100644 index 000000000..cfe4331c5 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-host-exception/index.md @@ -0,0 +1,34 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppHostException](index.md) + +# MiniAppHostException + +[androidJvm]\ +class [MiniAppHostException](index.md)(serverMessage: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) : [MiniAppSdkException](../-mini-app-sdk-exception/index.md) + +Exception which is thrown when the provided project ID does not have any mini app exist on the server. + +## Constructors + +| | | +|---|---| +| [MiniAppHostException](-mini-app-host-exception.md) | [androidJvm]
fun [MiniAppHostException](-mini-app-host-exception.md)(serverMessage: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) | + +## Functions + +| Name | Summary | +|---|---| +| [addSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#282858770%2FFunctions%2F1451286739) | [androidJvm]
fun [addSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#282858770%2FFunctions%2F1451286739)(p0: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) | +| [fillInStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1102069925%2FFunctions%2F1451286739) | [androidJvm]
open fun [fillInStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1102069925%2FFunctions%2F1451286739)(): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) | +| [getLocalizedMessage](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1043865560%2FFunctions%2F1451286739) | [androidJvm]
open fun [getLocalizedMessage](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1043865560%2FFunctions%2F1451286739)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [getStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2050903719%2FFunctions%2F1451286739) | [androidJvm]
open fun [getStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2050903719%2FFunctions%2F1451286739)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[StackTraceElement](https://developer.android.com/reference/kotlin/java/lang/StackTraceElement.html)> | +| [getSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#672492560%2FFunctions%2F1451286739) | [androidJvm]
fun [getSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#672492560%2FFunctions%2F1451286739)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)> | +| [initCause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-418225042%2FFunctions%2F1451286739) | [androidJvm]
open fun [initCause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-418225042%2FFunctions%2F1451286739)(p0: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) | +| [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1769529168%2FFunctions%2F1451286739) | [androidJvm]
open fun [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1769529168%2FFunctions%2F1451286739)()
open fun [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1841853697%2FFunctions%2F1451286739)(p0: [PrintStream](https://developer.android.com/reference/kotlin/java/io/PrintStream.html))
open fun [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1175535278%2FFunctions%2F1451286739)(p0: [PrintWriter](https://developer.android.com/reference/kotlin/java/io/PrintWriter.html)) | +| [setStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2135801318%2FFunctions%2F1451286739) | [androidJvm]
open fun [setStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2135801318%2FFunctions%2F1451286739)(p0: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[StackTraceElement](https://developer.android.com/reference/kotlin/java/lang/StackTraceElement.html)>) | + +## Properties + +| Name | Summary | +|---|---| +| [cause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-654012527%2FProperties%2F1451286739) | [androidJvm]
open val [cause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-654012527%2FProperties%2F1451286739): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? | +| [message](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1824300659%2FProperties%2F1451286739) | [androidJvm]
open val [message](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1824300659%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/-companion/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/-companion/index.md new file mode 100644 index 000000000..67e12f619 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/-companion/index.md @@ -0,0 +1,6 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp](../../index.md)/[MiniAppInfo](../index.md)/[Companion](index.md) + +# Companion + +[androidJvm]\ +object [Companion](index.md) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/-mini-app-info.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/-mini-app-info.md new file mode 100644 index 000000000..35a30c484 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/-mini-app-info.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppInfo](index.md)/[MiniAppInfo](-mini-app-info.md) + +# MiniAppInfo + +[androidJvm]\ +fun [MiniAppInfo](-mini-app-info.md)(id: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), displayName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), icon: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), version: [Version](../-version/index.md), promotionalImageUrl: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, promotionalText: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/display-name.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/display-name.md new file mode 100644 index 000000000..147537280 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/display-name.md @@ -0,0 +1,9 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppInfo](index.md)/[displayName](display-name.md) + +# displayName + +[androidJvm]\ + +@SerializedName(value = "displayName") + +val [displayName](display-name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/icon.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/icon.md new file mode 100644 index 000000000..6e1435b12 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/icon.md @@ -0,0 +1,9 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppInfo](index.md)/[icon](icon.md) + +# icon + +[androidJvm]\ + +@SerializedName(value = "icon") + +val [icon](icon.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/id.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/id.md new file mode 100644 index 000000000..f1297d822 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/id.md @@ -0,0 +1,9 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppInfo](index.md)/[id](id.md) + +# id + +[androidJvm]\ + +@SerializedName(value = "id") + +val [id](id.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/index.md new file mode 100644 index 000000000..9dea80758 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/index.md @@ -0,0 +1,38 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppInfo](index.md) + +# MiniAppInfo + +[androidJvm]\ +data class [MiniAppInfo](index.md)(id: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), displayName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), icon: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), version: [Version](../-version/index.md), promotionalImageUrl: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, promotionalText: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) : [Parcelable](https://developer.android.com/reference/kotlin/android/os/Parcelable.html) + +This represents a Mini App entity. + +## Constructors + +| | | +|---|---| +| [MiniAppInfo](-mini-app-info.md) | [androidJvm]
fun [MiniAppInfo](-mini-app-info.md)(id: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), displayName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), icon: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), version: [Version](../-version/index.md), promotionalImageUrl: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, promotionalText: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) | + +## Types + +| Name | Summary | +|---|---| +| [Companion](-companion/index.md) | [androidJvm]
object [Companion](-companion/index.md) | + +## Functions + +| Name | Summary | +|---|---| +| [describeContents](../../com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/index.md#-1578325224%2FFunctions%2F1451286739) | [androidJvm]
abstract fun [describeContents](../../com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/index.md#-1578325224%2FFunctions%2F1451286739)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [writeToParcel](../../com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/index.md#-1754457655%2FFunctions%2F1451286739) | [androidJvm]
abstract fun [writeToParcel](../../com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/index.md#-1754457655%2FFunctions%2F1451286739)(p0: [Parcel](https://developer.android.com/reference/kotlin/android/os/Parcel.html), p1: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) | + +## Properties + +| Name | Summary | +|---|---| +| [displayName](display-name.md) | [androidJvm]
@SerializedName(value = "displayName")
val [displayName](display-name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Display name of the mini app. | +| [icon](icon.md) | [androidJvm]
@SerializedName(value = "icon")
val [icon](icon.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Icon of the mini app, obtainable from the provided data for this resource. | +| [id](id.md) | [androidJvm]
@SerializedName(value = "id")
val [id](id.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Mini App identifier unique to a mini app. | +| [promotionalImageUrl](promotional-image-url.md) | [androidJvm]
@SerializedName(value = "promotionalImageUrl")
val [promotionalImageUrl](promotional-image-url.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?
promotional image, obtainable from the provided data for this resource. | +| [promotionalText](promotional-text.md) | [androidJvm]
@SerializedName(value = "promotionalText")
val [promotionalText](promotional-text.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?
promotional details to share. | +| [version](version.md) | [androidJvm]
@SerializedName(value = "version")
val [version](version.md): [Version](../-version/index.md)
Version information of the mini app. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/promotional-image-url.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/promotional-image-url.md new file mode 100644 index 000000000..d906a7678 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/promotional-image-url.md @@ -0,0 +1,9 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppInfo](index.md)/[promotionalImageUrl](promotional-image-url.md) + +# promotionalImageUrl + +[androidJvm]\ + +@SerializedName(value = "promotionalImageUrl") + +val [promotionalImageUrl](promotional-image-url.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/promotional-text.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/promotional-text.md new file mode 100644 index 000000000..c8ff66026 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/promotional-text.md @@ -0,0 +1,9 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppInfo](index.md)/[promotionalText](promotional-text.md) + +# promotionalText + +[androidJvm]\ + +@SerializedName(value = "promotionalText") + +val [promotionalText](promotional-text.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/version.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/version.md new file mode 100644 index 000000000..857e7699f --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/version.md @@ -0,0 +1,9 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppInfo](index.md)/[version](version.md) + +# version + +[androidJvm]\ + +@SerializedName(value = "version") + +val [version](version.md): [Version](../-version/index.md) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-manifest/-mini-app-manifest.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-manifest/-mini-app-manifest.md new file mode 100644 index 000000000..8d2581503 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-manifest/-mini-app-manifest.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppManifest](index.md)/[MiniAppManifest](-mini-app-manifest.md) + +# MiniAppManifest + +[androidJvm]\ +fun [MiniAppManifest](-mini-app-manifest.md)(requiredPermissions: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[Pair](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)<[MiniAppCustomPermissionType](../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/index.md), [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>>, optionalPermissions: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[Pair](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)<[MiniAppCustomPermissionType](../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/index.md), [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>>, accessTokenPermissions: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[AccessTokenScope](../../com.rakuten.tech.mobile.miniapp.permission/-access-token-scope/index.md)>, customMetaData: [Map](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>, versionId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-manifest/access-token-permissions.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-manifest/access-token-permissions.md new file mode 100644 index 000000000..22d61fd5c --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-manifest/access-token-permissions.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppManifest](index.md)/[accessTokenPermissions](access-token-permissions.md) + +# accessTokenPermissions + +[androidJvm]\ +val [accessTokenPermissions](access-token-permissions.md): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[AccessTokenScope](../../com.rakuten.tech.mobile.miniapp.permission/-access-token-scope/index.md)> diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-manifest/custom-meta-data.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-manifest/custom-meta-data.md new file mode 100644 index 000000000..120566860 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-manifest/custom-meta-data.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppManifest](index.md)/[customMetaData](custom-meta-data.md) + +# customMetaData + +[androidJvm]\ +val [customMetaData](custom-meta-data.md): [Map](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)> diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-manifest/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-manifest/index.md new file mode 100644 index 000000000..5bd82c2a7 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-manifest/index.md @@ -0,0 +1,24 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppManifest](index.md) + +# MiniAppManifest + +[androidJvm]\ +data class [MiniAppManifest](index.md)(requiredPermissions: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[Pair](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)<[MiniAppCustomPermissionType](../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/index.md), [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>>, optionalPermissions: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[Pair](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)<[MiniAppCustomPermissionType](../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/index.md), [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>>, accessTokenPermissions: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[AccessTokenScope](../../com.rakuten.tech.mobile.miniapp.permission/-access-token-scope/index.md)>, customMetaData: [Map](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>, versionId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) + +A data class to represent data in the mini app's manifest. + +## Constructors + +| | | +|---|---| +| [MiniAppManifest](-mini-app-manifest.md) | [androidJvm]
fun [MiniAppManifest](-mini-app-manifest.md)(requiredPermissions: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[Pair](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)<[MiniAppCustomPermissionType](../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/index.md), [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>>, optionalPermissions: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[Pair](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)<[MiniAppCustomPermissionType](../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/index.md), [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>>, accessTokenPermissions: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[AccessTokenScope](../../com.rakuten.tech.mobile.miniapp.permission/-access-token-scope/index.md)>, customMetaData: [Map](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>, versionId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) | + +## Properties + +| Name | Summary | +|---|---| +| [accessTokenPermissions](access-token-permissions.md) | [androidJvm]
val [accessTokenPermissions](access-token-permissions.md): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[AccessTokenScope](../../com.rakuten.tech.mobile.miniapp.permission/-access-token-scope/index.md)>
List of audiences and scopes requested by Mini App. | +| [customMetaData](custom-meta-data.md) | [androidJvm]
val [customMetaData](custom-meta-data.md): [Map](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>
Custom metadata set by Mini App. | +| [optionalPermissions](optional-permissions.md) | [androidJvm]
val [optionalPermissions](optional-permissions.md): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[Pair](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)<[MiniAppCustomPermissionType](../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/index.md), [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>>
List of optional permissions requested by Mini App. | +| [requiredPermissions](required-permissions.md) | [androidJvm]
val [requiredPermissions](required-permissions.md): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[Pair](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)<[MiniAppCustomPermissionType](../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/index.md), [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>>
List of required permissions requested by Mini App. | +| [versionId](version-id.md) | [androidJvm]
val [versionId](version-id.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
the version id for the Mini App. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-manifest/optional-permissions.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-manifest/optional-permissions.md new file mode 100644 index 000000000..dce999962 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-manifest/optional-permissions.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppManifest](index.md)/[optionalPermissions](optional-permissions.md) + +# optionalPermissions + +[androidJvm]\ +val [optionalPermissions](optional-permissions.md): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[Pair](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)<[MiniAppCustomPermissionType](../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/index.md), [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>> diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-manifest/required-permissions.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-manifest/required-permissions.md new file mode 100644 index 000000000..d6c5a84ef --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-manifest/required-permissions.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppManifest](index.md)/[requiredPermissions](required-permissions.md) + +# requiredPermissions + +[androidJvm]\ +val [requiredPermissions](required-permissions.md): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[Pair](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)<[MiniAppCustomPermissionType](../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/index.md), [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>> diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-manifest/version-id.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-manifest/version-id.md new file mode 100644 index 000000000..15b558b3e --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-manifest/version-id.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppManifest](index.md)/[versionId](version-id.md) + +# versionId + +[androidJvm]\ +val [versionId](version-id.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-net-exception/-mini-app-net-exception.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-net-exception/-mini-app-net-exception.md new file mode 100644 index 000000000..c153e9380 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-net-exception/-mini-app-net-exception.md @@ -0,0 +1,10 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppNetException](index.md)/[MiniAppNetException](-mini-app-net-exception.md) + +# MiniAppNetException + +[androidJvm]\ +fun [MiniAppNetException](-mini-app-net-exception.md)(e: [Exception](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html)) + +fun [MiniAppNetException](-mini-app-net-exception.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) + +fun [MiniAppNetException](-mini-app-net-exception.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), cause: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-net-exception/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-net-exception/index.md new file mode 100644 index 000000000..0045b13ef --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-net-exception/index.md @@ -0,0 +1,38 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppNetException](index.md) + +# MiniAppNetException + +[androidJvm]\ +class [MiniAppNetException](index.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), cause: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?) : [MiniAppSdkException](../-mini-app-sdk-exception/index.md) + +Exception indicating that there was an issue with network connectivity. + +This usually means the device doesn't have internet access currently, so you should display the cached mini app version. + +## Constructors + +| | | +|---|---| +| [MiniAppNetException](-mini-app-net-exception.md) | [androidJvm]
fun [MiniAppNetException](-mini-app-net-exception.md)(e: [Exception](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html)) | +| [MiniAppNetException](-mini-app-net-exception.md) | [androidJvm]
fun [MiniAppNetException](-mini-app-net-exception.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) | +| [MiniAppNetException](-mini-app-net-exception.md) | [androidJvm]
fun [MiniAppNetException](-mini-app-net-exception.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), cause: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?) | + +## Functions + +| Name | Summary | +|---|---| +| [addSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#282858770%2FFunctions%2F1451286739) | [androidJvm]
fun [addSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#282858770%2FFunctions%2F1451286739)(p0: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) | +| [fillInStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1102069925%2FFunctions%2F1451286739) | [androidJvm]
open fun [fillInStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1102069925%2FFunctions%2F1451286739)(): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) | +| [getLocalizedMessage](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1043865560%2FFunctions%2F1451286739) | [androidJvm]
open fun [getLocalizedMessage](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1043865560%2FFunctions%2F1451286739)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [getStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2050903719%2FFunctions%2F1451286739) | [androidJvm]
open fun [getStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2050903719%2FFunctions%2F1451286739)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[StackTraceElement](https://developer.android.com/reference/kotlin/java/lang/StackTraceElement.html)> | +| [getSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#672492560%2FFunctions%2F1451286739) | [androidJvm]
fun [getSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#672492560%2FFunctions%2F1451286739)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)> | +| [initCause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-418225042%2FFunctions%2F1451286739) | [androidJvm]
open fun [initCause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-418225042%2FFunctions%2F1451286739)(p0: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) | +| [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1769529168%2FFunctions%2F1451286739) | [androidJvm]
open fun [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1769529168%2FFunctions%2F1451286739)()
open fun [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1841853697%2FFunctions%2F1451286739)(p0: [PrintStream](https://developer.android.com/reference/kotlin/java/io/PrintStream.html))
open fun [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1175535278%2FFunctions%2F1451286739)(p0: [PrintWriter](https://developer.android.com/reference/kotlin/java/io/PrintWriter.html)) | +| [setStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2135801318%2FFunctions%2F1451286739) | [androidJvm]
open fun [setStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2135801318%2FFunctions%2F1451286739)(p0: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[StackTraceElement](https://developer.android.com/reference/kotlin/java/lang/StackTraceElement.html)>) | + +## Properties + +| Name | Summary | +|---|---| +| [cause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-654012527%2FProperties%2F1451286739) | [androidJvm]
open val [cause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-654012527%2FProperties%2F1451286739): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? | +| [message](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1824300659%2FProperties%2F1451286739) | [androidJvm]
open val [message](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1824300659%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-not-found-exception/-mini-app-not-found-exception.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-not-found-exception/-mini-app-not-found-exception.md new file mode 100644 index 000000000..8e5a76666 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-not-found-exception/-mini-app-not-found-exception.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppNotFoundException](index.md)/[MiniAppNotFoundException](-mini-app-not-found-exception.md) + +# MiniAppNotFoundException + +[androidJvm]\ +fun [MiniAppNotFoundException](-mini-app-not-found-exception.md)(serverMessage: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-not-found-exception/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-not-found-exception/index.md new file mode 100644 index 000000000..118f5e021 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-not-found-exception/index.md @@ -0,0 +1,34 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppNotFoundException](index.md) + +# MiniAppNotFoundException + +[androidJvm]\ +class [MiniAppNotFoundException](index.md)(serverMessage: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) : [MiniAppSdkException](../-mini-app-sdk-exception/index.md) + +Exception which is thrown when the provided project ID does not have any mini app exist on the server. + +## Constructors + +| | | +|---|---| +| [MiniAppNotFoundException](-mini-app-not-found-exception.md) | [androidJvm]
fun [MiniAppNotFoundException](-mini-app-not-found-exception.md)(serverMessage: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) | + +## Functions + +| Name | Summary | +|---|---| +| [addSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#282858770%2FFunctions%2F1451286739) | [androidJvm]
fun [addSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#282858770%2FFunctions%2F1451286739)(p0: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) | +| [fillInStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1102069925%2FFunctions%2F1451286739) | [androidJvm]
open fun [fillInStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1102069925%2FFunctions%2F1451286739)(): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) | +| [getLocalizedMessage](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1043865560%2FFunctions%2F1451286739) | [androidJvm]
open fun [getLocalizedMessage](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1043865560%2FFunctions%2F1451286739)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [getStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2050903719%2FFunctions%2F1451286739) | [androidJvm]
open fun [getStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2050903719%2FFunctions%2F1451286739)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[StackTraceElement](https://developer.android.com/reference/kotlin/java/lang/StackTraceElement.html)> | +| [getSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#672492560%2FFunctions%2F1451286739) | [androidJvm]
fun [getSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#672492560%2FFunctions%2F1451286739)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)> | +| [initCause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-418225042%2FFunctions%2F1451286739) | [androidJvm]
open fun [initCause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-418225042%2FFunctions%2F1451286739)(p0: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) | +| [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1769529168%2FFunctions%2F1451286739) | [androidJvm]
open fun [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1769529168%2FFunctions%2F1451286739)()
open fun [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1841853697%2FFunctions%2F1451286739)(p0: [PrintStream](https://developer.android.com/reference/kotlin/java/io/PrintStream.html))
open fun [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1175535278%2FFunctions%2F1451286739)(p0: [PrintWriter](https://developer.android.com/reference/kotlin/java/io/PrintWriter.html)) | +| [setStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2135801318%2FFunctions%2F1451286739) | [androidJvm]
open fun [setStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2135801318%2FFunctions%2F1451286739)(p0: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[StackTraceElement](https://developer.android.com/reference/kotlin/java/lang/StackTraceElement.html)>) | + +## Properties + +| Name | Summary | +|---|---| +| [cause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-654012527%2FProperties%2F1451286739) | [androidJvm]
open val [cause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-654012527%2FProperties%2F1451286739): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? | +| [message](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1824300659%2FProperties%2F1451286739) | [androidJvm]
open val [message](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1824300659%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/-mini-app-sdk-config.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/-mini-app-sdk-config.md new file mode 100644 index 000000000..96fb34e50 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/-mini-app-sdk-config.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppSdkConfig](index.md)/[MiniAppSdkConfig](-mini-app-sdk-config.md) + +# MiniAppSdkConfig + +[androidJvm]\ +fun [MiniAppSdkConfig](-mini-app-sdk-config.md)(baseUrl: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), rasProjectId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), subscriptionKey: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), hostAppVersionId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = "", hostAppUserAgentInfo: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), isPreviewMode: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), requireSignatureVerification: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false, miniAppAnalyticsConfigList: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[MiniAppAnalyticsConfig](../../com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/index.md)> = emptyList(), sslPinningPublicKeyList: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)> = emptyList(), enableH5Ads: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false, maxStorageSizeLimitInBytes: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = "52428800") diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/base-url.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/base-url.md new file mode 100644 index 000000000..54ac7a32b --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/base-url.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppSdkConfig](index.md)/[baseUrl](base-url.md) + +# baseUrl + +[androidJvm]\ +val [baseUrl](base-url.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/enable-h5-ads.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/enable-h5-ads.md new file mode 100644 index 000000000..606bfe1bc --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/enable-h5-ads.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppSdkConfig](index.md)/[enableH5Ads](enable-h5-ads.md) + +# enableH5Ads + +[androidJvm]\ +val [enableH5Ads](enable-h5-ads.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/host-app-user-agent-info.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/host-app-user-agent-info.md new file mode 100644 index 000000000..9043dba41 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/host-app-user-agent-info.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppSdkConfig](index.md)/[hostAppUserAgentInfo](host-app-user-agent-info.md) + +# hostAppUserAgentInfo + +[androidJvm]\ +val [hostAppUserAgentInfo](host-app-user-agent-info.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/host-app-version-id.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/host-app-version-id.md new file mode 100644 index 000000000..25b16f0d3 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/host-app-version-id.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppSdkConfig](index.md)/[hostAppVersionId](host-app-version-id.md) + +# hostAppVersionId + +[androidJvm]\ +val [hostAppVersionId](host-app-version-id.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/index.md new file mode 100644 index 000000000..0ceaccbe0 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/index.md @@ -0,0 +1,37 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppSdkConfig](index.md) + +# MiniAppSdkConfig + +[androidJvm]\ +data class [MiniAppSdkConfig](index.md)(baseUrl: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), rasProjectId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), subscriptionKey: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), hostAppVersionId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), hostAppUserAgentInfo: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), isPreviewMode: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), requireSignatureVerification: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), miniAppAnalyticsConfigList: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[MiniAppAnalyticsConfig](../../com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/index.md)>, sslPinningPublicKeyList: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>, enableH5Ads: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), maxStorageSizeLimitInBytes: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) : [Parcelable](https://developer.android.com/reference/kotlin/android/os/Parcelable.html) + +This represents the configuration settings for the Mini App SDK. + +## Constructors + +| | | +|---|---| +| [MiniAppSdkConfig](-mini-app-sdk-config.md) | [androidJvm]
fun [MiniAppSdkConfig](-mini-app-sdk-config.md)(baseUrl: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), rasProjectId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), subscriptionKey: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), hostAppVersionId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = "", hostAppUserAgentInfo: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), isPreviewMode: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), requireSignatureVerification: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false, miniAppAnalyticsConfigList: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[MiniAppAnalyticsConfig](../../com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/index.md)> = emptyList(), sslPinningPublicKeyList: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)> = emptyList(), enableH5Ads: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false, maxStorageSizeLimitInBytes: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = "52428800") | + +## Functions + +| Name | Summary | +|---|---| +| [describeContents](../../com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/index.md#-1578325224%2FFunctions%2F1451286739) | [androidJvm]
abstract fun [describeContents](../../com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/index.md#-1578325224%2FFunctions%2F1451286739)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [writeToParcel](../../com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/index.md#-1754457655%2FFunctions%2F1451286739) | [androidJvm]
abstract fun [writeToParcel](../../com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/index.md#-1754457655%2FFunctions%2F1451286739)(p0: [Parcel](https://developer.android.com/reference/kotlin/android/os/Parcel.html), p1: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) | + +## Properties + +| Name | Summary | +|---|---| +| [baseUrl](base-url.md) | [androidJvm]
val [baseUrl](base-url.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Base URL used for retrieving a Mini App. | +| [enableH5Ads](enable-h5-ads.md) | [androidJvm]
val [enableH5Ads](enable-h5-ads.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false
Whether the host app wants to enable ad placement beta. | +| [hostAppUserAgentInfo](host-app-user-agent-info.md) | [androidJvm]
val [hostAppUserAgentInfo](host-app-user-agent-info.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
User Agent information from Host App. | +| [hostAppVersionId](host-app-version-id.md) | [androidJvm]
val [hostAppVersionId](host-app-version-id.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Version of the host app, used to determine feature compatibility for Mini App. | +| [isPreviewMode](is-preview-mode.md) | [androidJvm]
val [isPreviewMode](is-preview-mode.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Whether the host app wants to use the API Endpoints under "Preview" mode. | +| [maxStorageSizeLimitInBytes](max-storage-size-limit-in-bytes.md) | [androidJvm]
val [maxStorageSizeLimitInBytes](max-storage-size-limit-in-bytes.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Maximum Secure Storage size limit in bytes for each Mini App, Default is 5MB. | +| [miniAppAnalyticsConfigList](mini-app-analytics-config-list.md) | [androidJvm]
val [miniAppAnalyticsConfigList](mini-app-analytics-config-list.md): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[MiniAppAnalyticsConfig](../../com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/index.md)>
List of analytic config to send events on. | +| [rasProjectId](ras-project-id.md) | [androidJvm]
val [rasProjectId](ras-project-id.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Project ID for the Platform API. | +| [requireSignatureVerification](require-signature-verification.md) | [androidJvm]
val [requireSignatureVerification](require-signature-verification.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false
Whether the Mini App SDK verifies signature of a Mini App. | +| [sslPinningPublicKeyList](ssl-pinning-public-key-list.md) | [androidJvm]
val [sslPinningPublicKeyList](ssl-pinning-public-key-list.md): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>
List of SSL pinning public keys. | +| [subscriptionKey](subscription-key.md) | [androidJvm]
val [subscriptionKey](subscription-key.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Subscription Key for the Platform API. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/is-preview-mode.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/is-preview-mode.md new file mode 100644 index 000000000..20dd2569b --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/is-preview-mode.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppSdkConfig](index.md)/[isPreviewMode](is-preview-mode.md) + +# isPreviewMode + +[androidJvm]\ +val [isPreviewMode](is-preview-mode.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/max-storage-size-limit-in-bytes.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/max-storage-size-limit-in-bytes.md new file mode 100644 index 000000000..633d9441a --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/max-storage-size-limit-in-bytes.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppSdkConfig](index.md)/[maxStorageSizeLimitInBytes](max-storage-size-limit-in-bytes.md) + +# maxStorageSizeLimitInBytes + +[androidJvm]\ +val [maxStorageSizeLimitInBytes](max-storage-size-limit-in-bytes.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/mini-app-analytics-config-list.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/mini-app-analytics-config-list.md new file mode 100644 index 000000000..d900b2c93 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/mini-app-analytics-config-list.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppSdkConfig](index.md)/[miniAppAnalyticsConfigList](mini-app-analytics-config-list.md) + +# miniAppAnalyticsConfigList + +[androidJvm]\ +val [miniAppAnalyticsConfigList](mini-app-analytics-config-list.md): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[MiniAppAnalyticsConfig](../../com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/index.md)> diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/ras-project-id.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/ras-project-id.md new file mode 100644 index 000000000..75c54ff08 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/ras-project-id.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppSdkConfig](index.md)/[rasProjectId](ras-project-id.md) + +# rasProjectId + +[androidJvm]\ +val [rasProjectId](ras-project-id.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/require-signature-verification.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/require-signature-verification.md new file mode 100644 index 000000000..69f6fa00d --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/require-signature-verification.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppSdkConfig](index.md)/[requireSignatureVerification](require-signature-verification.md) + +# requireSignatureVerification + +[androidJvm]\ +val [requireSignatureVerification](require-signature-verification.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/ssl-pinning-public-key-list.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/ssl-pinning-public-key-list.md new file mode 100644 index 000000000..c1e19ad54 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/ssl-pinning-public-key-list.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppSdkConfig](index.md)/[sslPinningPublicKeyList](ssl-pinning-public-key-list.md) + +# sslPinningPublicKeyList + +[androidJvm]\ +val [sslPinningPublicKeyList](ssl-pinning-public-key-list.md): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)> diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/subscription-key.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/subscription-key.md new file mode 100644 index 000000000..7710b9386 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/subscription-key.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppSdkConfig](index.md)/[subscriptionKey](subscription-key.md) + +# subscriptionKey + +[androidJvm]\ +val [subscriptionKey](subscription-key.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-exception/-mini-app-sdk-exception.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-exception/-mini-app-sdk-exception.md new file mode 100644 index 000000000..93301ab25 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-exception/-mini-app-sdk-exception.md @@ -0,0 +1,10 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppSdkException](index.md)/[MiniAppSdkException](-mini-app-sdk-exception.md) + +# MiniAppSdkException + +[androidJvm]\ +fun [MiniAppSdkException](-mini-app-sdk-exception.md)(e: [Exception](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html)) + +fun [MiniAppSdkException](-mini-app-sdk-exception.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) + +fun [MiniAppSdkException](-mini-app-sdk-exception.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), cause: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-exception/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-exception/index.md new file mode 100644 index 000000000..246e8e7fd --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-exception/index.md @@ -0,0 +1,52 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppSdkException](index.md) + +# MiniAppSdkException + +[androidJvm]\ +open class [MiniAppSdkException](index.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), cause: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?) : [Exception](https://developer.android.com/reference/kotlin/java/lang/Exception.html) + +A custom exception class which treats the purpose of providing error information to the consumer app in an unified way. + +## Constructors + +| | | +|---|---| +| [MiniAppSdkException](-mini-app-sdk-exception.md) | [androidJvm]
fun [MiniAppSdkException](-mini-app-sdk-exception.md)(e: [Exception](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html)) | +| [MiniAppSdkException](-mini-app-sdk-exception.md) | [androidJvm]
fun [MiniAppSdkException](-mini-app-sdk-exception.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) | +| [MiniAppSdkException](-mini-app-sdk-exception.md) | [androidJvm]
fun [MiniAppSdkException](-mini-app-sdk-exception.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), cause: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?) | + +## Functions + +| Name | Summary | +|---|---| +| [addSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#282858770%2FFunctions%2F1451286739) | [androidJvm]
fun [addSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#282858770%2FFunctions%2F1451286739)(p0: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) | +| [fillInStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1102069925%2FFunctions%2F1451286739) | [androidJvm]
open fun [fillInStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1102069925%2FFunctions%2F1451286739)(): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) | +| [getLocalizedMessage](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1043865560%2FFunctions%2F1451286739) | [androidJvm]
open fun [getLocalizedMessage](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1043865560%2FFunctions%2F1451286739)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [getStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2050903719%2FFunctions%2F1451286739) | [androidJvm]
open fun [getStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2050903719%2FFunctions%2F1451286739)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[StackTraceElement](https://developer.android.com/reference/kotlin/java/lang/StackTraceElement.html)> | +| [getSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#672492560%2FFunctions%2F1451286739) | [androidJvm]
fun [getSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#672492560%2FFunctions%2F1451286739)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)> | +| [initCause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-418225042%2FFunctions%2F1451286739) | [androidJvm]
open fun [initCause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-418225042%2FFunctions%2F1451286739)(p0: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) | +| [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1769529168%2FFunctions%2F1451286739) | [androidJvm]
open fun [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1769529168%2FFunctions%2F1451286739)()
open fun [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1841853697%2FFunctions%2F1451286739)(p0: [PrintStream](https://developer.android.com/reference/kotlin/java/io/PrintStream.html))
open fun [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1175535278%2FFunctions%2F1451286739)(p0: [PrintWriter](https://developer.android.com/reference/kotlin/java/io/PrintWriter.html)) | +| [setStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2135801318%2FFunctions%2F1451286739) | [androidJvm]
open fun [setStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2135801318%2FFunctions%2F1451286739)(p0: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[StackTraceElement](https://developer.android.com/reference/kotlin/java/lang/StackTraceElement.html)>) | + +## Properties + +| Name | Summary | +|---|---| +| [cause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-654012527%2FProperties%2F1451286739) | [androidJvm]
open val [cause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-654012527%2FProperties%2F1451286739): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? | +| [message](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1824300659%2FProperties%2F1451286739) | [androidJvm]
open val [message](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1824300659%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? | + +## Inheritors + +| Name | +|---| +| [MiniAppHasNoPublishedVersionException](../-mini-app-has-no-published-version-exception/index.md) | +| [SSLCertificatePinningException](../-s-s-l-certificate-pinning-exception/index.md) | +| [MiniAppNotFoundException](../-mini-app-not-found-exception/index.md) | +| [MiniAppBundleNotFoundException](../-mini-app-bundle-not-found-exception/index.md) | +| [MiniAppHostException](../-mini-app-host-exception/index.md) | +| [MiniAppVerificationException](../-mini-app-verification-exception/index.md) | +| [InvalidMiniAppInfoException](../-invalid-mini-app-info-exception/index.md) | +| [MiniAppHasCorruptedException](../-mini-app-has-corrupted-exception/index.md) | +| [RequiredPermissionsNotGrantedException](../-required-permissions-not-granted-exception/index.md) | +| [MiniAppNetException](../-mini-app-net-exception/index.md) | +| [MiniAppTooManyRequestsError](../-mini-app-too-many-requests-error/index.md) | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-too-many-requests-error/-mini-app-too-many-requests-error.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-too-many-requests-error/-mini-app-too-many-requests-error.md new file mode 100644 index 000000000..09c5dcaaa --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-too-many-requests-error/-mini-app-too-many-requests-error.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppTooManyRequestsError](index.md)/[MiniAppTooManyRequestsError](-mini-app-too-many-requests-error.md) + +# MiniAppTooManyRequestsError + +[androidJvm]\ +fun [MiniAppTooManyRequestsError](-mini-app-too-many-requests-error.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-too-many-requests-error/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-too-many-requests-error/index.md new file mode 100644 index 000000000..2a1fd0de8 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-too-many-requests-error/index.md @@ -0,0 +1,34 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppTooManyRequestsError](index.md) + +# MiniAppTooManyRequestsError + +[androidJvm]\ +class [MiniAppTooManyRequestsError](index.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) : [MiniAppSdkException](../-mini-app-sdk-exception/index.md) + +Exception which is thrown when there are too many requests for a MiniApp. + +## Constructors + +| | | +|---|---| +| [MiniAppTooManyRequestsError](-mini-app-too-many-requests-error.md) | [androidJvm]
fun [MiniAppTooManyRequestsError](-mini-app-too-many-requests-error.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) | + +## Functions + +| Name | Summary | +|---|---| +| [addSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#282858770%2FFunctions%2F1451286739) | [androidJvm]
fun [addSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#282858770%2FFunctions%2F1451286739)(p0: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) | +| [fillInStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1102069925%2FFunctions%2F1451286739) | [androidJvm]
open fun [fillInStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1102069925%2FFunctions%2F1451286739)(): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) | +| [getLocalizedMessage](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1043865560%2FFunctions%2F1451286739) | [androidJvm]
open fun [getLocalizedMessage](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1043865560%2FFunctions%2F1451286739)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [getStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2050903719%2FFunctions%2F1451286739) | [androidJvm]
open fun [getStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2050903719%2FFunctions%2F1451286739)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[StackTraceElement](https://developer.android.com/reference/kotlin/java/lang/StackTraceElement.html)> | +| [getSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#672492560%2FFunctions%2F1451286739) | [androidJvm]
fun [getSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#672492560%2FFunctions%2F1451286739)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)> | +| [initCause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-418225042%2FFunctions%2F1451286739) | [androidJvm]
open fun [initCause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-418225042%2FFunctions%2F1451286739)(p0: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) | +| [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1769529168%2FFunctions%2F1451286739) | [androidJvm]
open fun [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1769529168%2FFunctions%2F1451286739)()
open fun [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1841853697%2FFunctions%2F1451286739)(p0: [PrintStream](https://developer.android.com/reference/kotlin/java/io/PrintStream.html))
open fun [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1175535278%2FFunctions%2F1451286739)(p0: [PrintWriter](https://developer.android.com/reference/kotlin/java/io/PrintWriter.html)) | +| [setStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2135801318%2FFunctions%2F1451286739) | [androidJvm]
open fun [setStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2135801318%2FFunctions%2F1451286739)(p0: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[StackTraceElement](https://developer.android.com/reference/kotlin/java/lang/StackTraceElement.html)>) | + +## Properties + +| Name | Summary | +|---|---| +| [cause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-654012527%2FProperties%2F1451286739) | [androidJvm]
open val [cause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-654012527%2FProperties%2F1451286739): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? | +| [message](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1824300659%2FProperties%2F1451286739) | [androidJvm]
open val [message](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1824300659%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-verification-exception/-mini-app-verification-exception.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-verification-exception/-mini-app-verification-exception.md new file mode 100644 index 000000000..701c6166b --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-verification-exception/-mini-app-verification-exception.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppVerificationException](index.md)/[MiniAppVerificationException](-mini-app-verification-exception.md) + +# MiniAppVerificationException + +[androidJvm]\ +fun [MiniAppVerificationException](-mini-app-verification-exception.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-verification-exception/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-verification-exception/index.md new file mode 100644 index 000000000..29f52307e --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-verification-exception/index.md @@ -0,0 +1,34 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniAppVerificationException](index.md) + +# MiniAppVerificationException + +[androidJvm]\ +class [MiniAppVerificationException](index.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) : [MiniAppSdkException](../-mini-app-sdk-exception/index.md) + +Exception which is thrown when cannot verify device keystore. + +## Constructors + +| | | +|---|---| +| [MiniAppVerificationException](-mini-app-verification-exception.md) | [androidJvm]
fun [MiniAppVerificationException](-mini-app-verification-exception.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) | + +## Functions + +| Name | Summary | +|---|---| +| [addSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#282858770%2FFunctions%2F1451286739) | [androidJvm]
fun [addSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#282858770%2FFunctions%2F1451286739)(p0: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) | +| [fillInStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1102069925%2FFunctions%2F1451286739) | [androidJvm]
open fun [fillInStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1102069925%2FFunctions%2F1451286739)(): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) | +| [getLocalizedMessage](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1043865560%2FFunctions%2F1451286739) | [androidJvm]
open fun [getLocalizedMessage](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1043865560%2FFunctions%2F1451286739)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [getStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2050903719%2FFunctions%2F1451286739) | [androidJvm]
open fun [getStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2050903719%2FFunctions%2F1451286739)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[StackTraceElement](https://developer.android.com/reference/kotlin/java/lang/StackTraceElement.html)> | +| [getSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#672492560%2FFunctions%2F1451286739) | [androidJvm]
fun [getSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#672492560%2FFunctions%2F1451286739)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)> | +| [initCause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-418225042%2FFunctions%2F1451286739) | [androidJvm]
open fun [initCause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-418225042%2FFunctions%2F1451286739)(p0: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) | +| [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1769529168%2FFunctions%2F1451286739) | [androidJvm]
open fun [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1769529168%2FFunctions%2F1451286739)()
open fun [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1841853697%2FFunctions%2F1451286739)(p0: [PrintStream](https://developer.android.com/reference/kotlin/java/io/PrintStream.html))
open fun [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1175535278%2FFunctions%2F1451286739)(p0: [PrintWriter](https://developer.android.com/reference/kotlin/java/io/PrintWriter.html)) | +| [setStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2135801318%2FFunctions%2F1451286739) | [androidJvm]
open fun [setStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2135801318%2FFunctions%2F1451286739)(p0: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[StackTraceElement](https://developer.android.com/reference/kotlin/java/lang/StackTraceElement.html)>) | + +## Properties + +| Name | Summary | +|---|---| +| [cause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-654012527%2FProperties%2F1451286739) | [androidJvm]
open val [cause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-654012527%2FProperties%2F1451286739): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? | +| [message](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1824300659%2FProperties%2F1451286739) | [androidJvm]
open val [message](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1824300659%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/-companion/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/-companion/index.md new file mode 100644 index 000000000..630d21f14 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/-companion/index.md @@ -0,0 +1,12 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp](../../index.md)/[MiniApp](../index.md)/[Companion](index.md) + +# Companion + +[androidJvm]\ +object [Companion](index.md) + +## Functions + +| Name | Summary | +|---|---| +| [instance](instance.md) | [androidJvm]
@[JvmStatic](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-static/index.html)
fun [instance](instance.md)(settings: [MiniAppSdkConfig](../../-mini-app-sdk-config/index.md) = defaultConfig, setConfigAsDefault: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = true): [MiniApp](../index.md)
Instance of [MiniApp](../index.md) which uses the default config settings, as defined in AndroidManifest.xml. For usual scenarios the default config suffices. However, should it be required to change the config at runtime for QA purpose or similar, another [MiniAppSdkConfig](../../-mini-app-sdk-config/index.md) can be provided for customization. [setConfigAsDefault](instance.md) is to use the config as default. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/-companion/instance.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/-companion/instance.md new file mode 100644 index 000000000..6198736c9 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/-companion/instance.md @@ -0,0 +1,15 @@ +//[miniapp](../../../../index.md)/[com.rakuten.tech.mobile.miniapp](../../index.md)/[MiniApp](../index.md)/[Companion](index.md)/[instance](instance.md) + +# instance + +[androidJvm]\ + +@[JvmStatic](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-static/index.html) + +fun [instance](instance.md)(settings: [MiniAppSdkConfig](../../-mini-app-sdk-config/index.md) = defaultConfig, setConfigAsDefault: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = true): [MiniApp](../index.md) + +Instance of [MiniApp](../index.md) which uses the default config settings, as defined in AndroidManifest.xml. For usual scenarios the default config suffices. However, should it be required to change the config at runtime for QA purpose or similar, another [MiniAppSdkConfig](../../-mini-app-sdk-config/index.md) can be provided for customization. [setConfigAsDefault](instance.md) is to use the config as default. + +#### Return + +[MiniApp](../index.md) instance diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/clear-secure-storage.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/clear-secure-storage.md new file mode 100644 index 000000000..12430e774 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/clear-secure-storage.md @@ -0,0 +1,17 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniApp](index.md)/[clearSecureStorage](clear-secure-storage.md) + +# clearSecureStorage + +[androidJvm]\ +abstract fun [clearSecureStorage](clear-secure-storage.md)(context: [Context](https://developer.android.com/reference/kotlin/android/content/Context.html), miniAppId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Clears the secure storage for a particular Mini App ID. + +## Parameters + +androidJvm + +| | | +|---|---| +| context | will be used to find the storage to be deleted. | +| miniAppId | will be used to find the storage to be deleted. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/clear-secure-storages.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/clear-secure-storages.md new file mode 100644 index 000000000..a0d1b387d --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/clear-secure-storages.md @@ -0,0 +1,16 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniApp](index.md)/[clearSecureStorages](clear-secure-storages.md) + +# clearSecureStorages + +[androidJvm]\ +abstract fun [clearSecureStorages](clear-secure-storages.md)(context: [Context](https://developer.android.com/reference/kotlin/android/content/Context.html)) + +Clears all secure storage items for all mini apps. + +## Parameters + +androidJvm + +| | | +|---|---| +| context | will be used to find the storage to be deleted. Host App should call this when they want to clear all sensitive and session data such as when a user logs out. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/create-with-url.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/create-with-url.md new file mode 100644 index 000000000..3cca49b1f --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/create-with-url.md @@ -0,0 +1,27 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniApp](index.md)/[createWithUrl](create-with-url.md) + +# createWithUrl + +[androidJvm]\ +~~abstract~~ ~~suspend~~ ~~fun~~ [~~createWithUrl~~](create-with-url.md)~~(~~~~appUrl~~~~:~~ [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)~~,~~ ~~miniAppMessageBridge~~~~:~~ [MiniAppMessageBridge](../../com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/index.md)~~,~~ ~~miniAppNavigator~~~~:~~ [MiniAppNavigator](../../com.rakuten.tech.mobile.miniapp.navigator/-mini-app-navigator/index.md)? ~~=~~ ~~null~~~~,~~ ~~miniAppFileChooser~~~~:~~ [MiniAppFileChooser](../../com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser/index.md)? ~~=~~ ~~null~~~~,~~ ~~queryParams~~~~:~~ [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) ~~=~~ ~~""~~~~)~~~~:~~ [MiniAppDisplay](../-mini-app-display/index.md) + +Creates a mini app using provided url. Mini app is NOT downloaded and cached in local, its content are read directly from the url. This should only be used for previewing a mini app from a local server. + +## Parameters + +androidJvm + +| | | +|---|---| +| appUrl | a HTTP url containing Mini App content. | +| miniAppMessageBridge | the interface for communicating between host app & mini app. | +| miniAppNavigator | allow host app to handle specific urls such as external link. | +| miniAppFileChooser | allow host app to get the file path while choosing file inside the webview. | +| queryParams | the parameters will be appended with the miniapp url scheme. | + +## Throws + +| | | +|---|---| +| [com.rakuten.tech.mobile.miniapp.MiniAppNotFoundException](../-mini-app-not-found-exception/index.md) | when the specified Mini App URL cannot be reached. | +| [com.rakuten.tech.mobile.miniapp.MiniAppSdkException](../-mini-app-sdk-exception/index.md) | when there is any other issue during loading or creating the view. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/create.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/create.md new file mode 100644 index 000000000..1722f4343 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/create.md @@ -0,0 +1,57 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniApp](index.md)/[create](create.md) + +# create + +[androidJvm]\ +~~abstract~~ ~~suspend~~ ~~fun~~ [~~create~~](create.md)~~(~~~~appId~~~~:~~ [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)~~,~~ ~~miniAppMessageBridge~~~~:~~ [MiniAppMessageBridge](../../com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/index.md)~~,~~ ~~miniAppNavigator~~~~:~~ [MiniAppNavigator](../../com.rakuten.tech.mobile.miniapp.navigator/-mini-app-navigator/index.md)? ~~=~~ ~~null~~~~,~~ ~~miniAppFileChooser~~~~:~~ [MiniAppFileChooser](../../com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser/index.md)? ~~=~~ ~~null~~~~,~~ ~~queryParams~~~~:~~ [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) ~~=~~ ~~""~~~~,~~ ~~fromCache~~~~:~~ [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) ~~=~~ ~~false~~~~)~~~~:~~ [MiniAppDisplay](../-mini-app-display/index.md) + +Creates a mini app. The mini app is downloaded, saved and provides a [MiniAppDisplay](../-mini-app-display/index.md) when successful. + +## Parameters + +androidJvm + +| | | +|---|---| +| appId | mini app id. | +| miniAppMessageBridge | the interface for communicating between host app & mini app. | +| miniAppNavigator | allow host app to handle specific urls such as external link. | +| miniAppFileChooser | allow host app to get the file path while choosing file inside the webview. | +| queryParams | the parameters will be appended with the miniapp url scheme. | +| fromCache | allow host app to load miniapp from cache. | + +## Throws + +| | | +|---|---| +| [com.rakuten.tech.mobile.miniapp.MiniAppNotFoundException](../-mini-app-not-found-exception/index.md) | when the specified project ID does not have any mini app exist on the server. | +| [com.rakuten.tech.mobile.miniapp.MiniAppHasNoPublishedVersionException](../-mini-app-has-no-published-version-exception/index.md) | when the specified mini app ID exists on the server but has no published versions | +| [com.rakuten.tech.mobile.miniapp.MiniAppSdkException](../-mini-app-sdk-exception/index.md) | when there is any other issue during fetching, downloading or creating the view. | +| [com.rakuten.tech.mobile.miniapp.RequiredPermissionsNotGrantedException](../-required-permissions-not-granted-exception/index.md) | when the required permissions of the manifest are not granted. | + +[androidJvm]\ +~~abstract~~ ~~suspend~~ ~~fun~~ [~~create~~](create.md)~~(~~~~appInfo~~~~:~~ [MiniAppInfo](../-mini-app-info/index.md)~~,~~ ~~miniAppMessageBridge~~~~:~~ [MiniAppMessageBridge](../../com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/index.md)~~,~~ ~~miniAppNavigator~~~~:~~ [MiniAppNavigator](../../com.rakuten.tech.mobile.miniapp.navigator/-mini-app-navigator/index.md)? ~~=~~ ~~null~~~~,~~ ~~miniAppFileChooser~~~~:~~ [MiniAppFileChooser](../../com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser/index.md)? ~~=~~ ~~null~~~~,~~ ~~queryParams~~~~:~~ [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) ~~=~~ ~~""~~~~,~~ ~~fromCache~~~~:~~ [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) ~~=~~ ~~false~~~~)~~~~:~~ [MiniAppDisplay](../-mini-app-display/index.md) + +Creates a mini app using the mini app ID and version specified in [MiniAppInfo](../-mini-app-info/index.md). This should only be used in "Preview Mode". The mini app is downloaded, saved and provides a [MiniAppDisplay](../-mini-app-display/index.md) when successful. + +## Parameters + +androidJvm + +| | | +|---|---| +| appInfo | metadata of a mini app. | +| miniAppMessageBridge | the interface for communicating between host app & mini app. | +| miniAppNavigator | allow host app to handle specific urls such as external link. | +| miniAppFileChooser | allow host app to get the file path while choosing file inside the webview. | +| queryParams | the parameters will be appended with the miniapp url scheme. | +| fromCache | allow host app to load miniapp from cache. | + +## Throws + +| | | +|---|---| +| [com.rakuten.tech.mobile.miniapp.MiniAppNotFoundException](../-mini-app-not-found-exception/index.md) | when the specified project ID does not have any mini app exist on the server. | +| [com.rakuten.tech.mobile.miniapp.MiniAppHasNoPublishedVersionException](../-mini-app-has-no-published-version-exception/index.md) | when the specified mini app ID exists on the server but has no published versions | +| [com.rakuten.tech.mobile.miniapp.MiniAppSdkException](../-mini-app-sdk-exception/index.md) | when there is any other issue during fetching, downloading or creating the view. | +| [com.rakuten.tech.mobile.miniapp.RequiredPermissionsNotGrantedException](../-required-permissions-not-granted-exception/index.md) | when the required permissions of the manifest are not granted. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/download-mini-app.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/download-mini-app.md new file mode 100644 index 000000000..a6803378b --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/download-mini-app.md @@ -0,0 +1,18 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniApp](index.md)/[downloadMiniApp](download-mini-app.md) + +# downloadMiniApp + +[androidJvm]\ +abstract suspend fun [downloadMiniApp](download-mini-app.md)(miniAppId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), versionId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), completionHandler: (success: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), [MiniAppSdkException](../-mini-app-sdk-exception/index.md)?) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) + +download and store a MiniApp. + +## Parameters + +androidJvm + +| | | +|---|---| +| miniAppId | will be the id of the MiniApp. | +| versionId | will be the version of the MiniApp. | +| completionHandler | callback when the MiniApp is successfully downloaded. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/fetch-info.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/fetch-info.md new file mode 100644 index 000000000..69c6e2a5e --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/fetch-info.md @@ -0,0 +1,20 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniApp](index.md)/[fetchInfo](fetch-info.md) + +# fetchInfo + +[androidJvm]\ +abstract suspend fun [fetchInfo](fetch-info.md)(appId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [MiniAppInfo](../-mini-app-info/index.md) + +Fetches meta data information of a mini app. + +#### Return + +[MiniAppInfo](../-mini-app-info/index.md) for the provided appId of a mini app + +## Throws + +| | | +|---|---| +| [com.rakuten.tech.mobile.miniapp.MiniAppNotFoundException](../-mini-app-not-found-exception/index.md) | when the specified project ID does not have any mini app exist on the server. | +| [com.rakuten.tech.mobile.miniapp.MiniAppHasNoPublishedVersionException](../-mini-app-has-no-published-version-exception/index.md) | when the specified mini app ID exists on the server but has no published versions | +| [com.rakuten.tech.mobile.miniapp.MiniAppSdkException](../-mini-app-sdk-exception/index.md) | when fetching fails from the BE server for any other reason. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/get-custom-permissions.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/get-custom-permissions.md new file mode 100644 index 000000000..dcaa3eec8 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/get-custom-permissions.md @@ -0,0 +1,20 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniApp](index.md)/[getCustomPermissions](get-custom-permissions.md) + +# getCustomPermissions + +[androidJvm]\ +abstract fun [getCustomPermissions](get-custom-permissions.md)(miniAppId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [MiniAppCustomPermission](../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission/index.md) + +Get custom permissions with grant results per MiniApp from this SDK. + +#### Return + +[MiniAppCustomPermission](../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission/index.md) an object contains the grant results per mini app. + +## Parameters + +androidJvm + +| | | +|---|---| +| miniAppId | mini app id as the key to retrieve data from cache. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/get-downloaded-manifest.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/get-downloaded-manifest.md new file mode 100644 index 000000000..201ee238f --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/get-downloaded-manifest.md @@ -0,0 +1,20 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniApp](index.md)/[getDownloadedManifest](get-downloaded-manifest.md) + +# getDownloadedManifest + +[androidJvm]\ +abstract fun [getDownloadedManifest](get-downloaded-manifest.md)(appId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [MiniAppManifest](../-mini-app-manifest/index.md)? + +Get the currently downloaded manifest information e.g. required and optional permissions. + +#### Return + +MiniAppManifest an object contains manifest information of a miniapp. + +## Parameters + +androidJvm + +| | | +|---|---| +| appId | mini app id. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/get-mini-app-info-by-preview-code.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/get-mini-app-info-by-preview-code.md new file mode 100644 index 000000000..b8e21b4e8 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/get-mini-app-info-by-preview-code.md @@ -0,0 +1,18 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniApp](index.md)/[getMiniAppInfoByPreviewCode](get-mini-app-info-by-preview-code.md) + +# getMiniAppInfoByPreviewCode + +[androidJvm]\ +abstract suspend fun [getMiniAppInfoByPreviewCode](get-mini-app-info-by-preview-code.md)(previewCode: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [PreviewMiniAppInfo](../-preview-mini-app-info/index.md) + +Fetches MiniappInfo by preview code. + +#### Return + +of type [MiniAppInfo](../-mini-app-info/index.md) when obtained successfully + +## Throws + +| | | +|---|---| +| [com.rakuten.tech.mobile.miniapp.MiniAppSdkException](../-mini-app-sdk-exception/index.md) | when fetching fails from the BE server for any reason. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/get-mini-app-manifest.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/get-mini-app-manifest.md new file mode 100644 index 000000000..637049ac7 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/get-mini-app-manifest.md @@ -0,0 +1,22 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniApp](index.md)/[getMiniAppManifest](get-mini-app-manifest.md) + +# getMiniAppManifest + +[androidJvm]\ +abstract suspend fun [getMiniAppManifest](get-mini-app-manifest.md)(appId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), versionId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), languageCode: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = ""): [MiniAppManifest](../-mini-app-manifest/index.md) + +Get the manifest information e.g. required and optional permissions. + +#### Return + +MiniAppManifest an object contains manifest information of a mini app. + +## Parameters + +androidJvm + +| | | +|---|---| +| appId | mini app id. | +| versionId | of mini app. | +| languageCode | of mini app. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/index.md new file mode 100644 index 000000000..e801a2b7e --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/index.md @@ -0,0 +1,34 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniApp](index.md) + +# MiniApp + +[androidJvm]\ +abstract class [MiniApp](index.md) + +This represents the contract between the consuming application and the SDK by which operations in the mini app ecosystem are exposed. Should be accessed via [MiniApp.instance](-companion/instance.md). + +## Types + +| Name | Summary | +|---|---| +| [Companion](-companion/index.md) | [androidJvm]
object [Companion](-companion/index.md) | + +## Functions + +| Name | Summary | +|---|---| +| [clearSecureStorage](clear-secure-storage.md) | [androidJvm]
abstract fun [clearSecureStorage](clear-secure-storage.md)(context: [Context](https://developer.android.com/reference/kotlin/android/content/Context.html), miniAppId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Clears the secure storage for a particular Mini App ID. | +| [clearSecureStorages](clear-secure-storages.md) | [androidJvm]
abstract fun [clearSecureStorages](clear-secure-storages.md)(context: [Context](https://developer.android.com/reference/kotlin/android/content/Context.html))
Clears all secure storage items for all mini apps. | +| [create](create.md) | [androidJvm]
~~abstract~~ ~~suspend~~ ~~fun~~ [~~create~~](create.md)~~(~~~~appInfo~~~~:~~ [MiniAppInfo](../-mini-app-info/index.md)~~,~~ ~~miniAppMessageBridge~~~~:~~ [MiniAppMessageBridge](../../com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/index.md)~~,~~ ~~miniAppNavigator~~~~:~~ [MiniAppNavigator](../../com.rakuten.tech.mobile.miniapp.navigator/-mini-app-navigator/index.md)? ~~=~~ ~~null~~~~,~~ ~~miniAppFileChooser~~~~:~~ [MiniAppFileChooser](../../com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser/index.md)? ~~=~~ ~~null~~~~,~~ ~~queryParams~~~~:~~ [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) ~~=~~ ~~""~~~~,~~ ~~fromCache~~~~:~~ [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) ~~=~~ ~~false~~~~)~~~~:~~ [MiniAppDisplay](../-mini-app-display/index.md)
Creates a mini app using the mini app ID and version specified in [MiniAppInfo](../-mini-app-info/index.md). This should only be used in "Preview Mode". The mini app is downloaded, saved and provides a [MiniAppDisplay](../-mini-app-display/index.md) when successful.
[androidJvm]
~~abstract~~ ~~suspend~~ ~~fun~~ [~~create~~](create.md)~~(~~~~appId~~~~:~~ [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)~~,~~ ~~miniAppMessageBridge~~~~:~~ [MiniAppMessageBridge](../../com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/index.md)~~,~~ ~~miniAppNavigator~~~~:~~ [MiniAppNavigator](../../com.rakuten.tech.mobile.miniapp.navigator/-mini-app-navigator/index.md)? ~~=~~ ~~null~~~~,~~ ~~miniAppFileChooser~~~~:~~ [MiniAppFileChooser](../../com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser/index.md)? ~~=~~ ~~null~~~~,~~ ~~queryParams~~~~:~~ [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) ~~=~~ ~~""~~~~,~~ ~~fromCache~~~~:~~ [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) ~~=~~ ~~false~~~~)~~~~:~~ [MiniAppDisplay](../-mini-app-display/index.md)
Creates a mini app. The mini app is downloaded, saved and provides a [MiniAppDisplay](../-mini-app-display/index.md) when successful. | +| [createWithUrl](create-with-url.md) | [androidJvm]
~~abstract~~ ~~suspend~~ ~~fun~~ [~~createWithUrl~~](create-with-url.md)~~(~~~~appUrl~~~~:~~ [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)~~,~~ ~~miniAppMessageBridge~~~~:~~ [MiniAppMessageBridge](../../com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/index.md)~~,~~ ~~miniAppNavigator~~~~:~~ [MiniAppNavigator](../../com.rakuten.tech.mobile.miniapp.navigator/-mini-app-navigator/index.md)? ~~=~~ ~~null~~~~,~~ ~~miniAppFileChooser~~~~:~~ [MiniAppFileChooser](../../com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser/index.md)? ~~=~~ ~~null~~~~,~~ ~~queryParams~~~~:~~ [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) ~~=~~ ~~""~~~~)~~~~:~~ [MiniAppDisplay](../-mini-app-display/index.md)
Creates a mini app using provided url. Mini app is NOT downloaded and cached in local, its content are read directly from the url. This should only be used for previewing a mini app from a local server. | +| [downloadMiniApp](download-mini-app.md) | [androidJvm]
abstract suspend fun [downloadMiniApp](download-mini-app.md)(miniAppId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), versionId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), completionHandler: (success: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), [MiniAppSdkException](../-mini-app-sdk-exception/index.md)?) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
download and store a MiniApp. | +| [fetchInfo](fetch-info.md) | [androidJvm]
abstract suspend fun [fetchInfo](fetch-info.md)(appId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [MiniAppInfo](../-mini-app-info/index.md)
Fetches meta data information of a mini app. | +| [getCustomPermissions](get-custom-permissions.md) | [androidJvm]
abstract fun [getCustomPermissions](get-custom-permissions.md)(miniAppId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [MiniAppCustomPermission](../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission/index.md)
Get custom permissions with grant results per MiniApp from this SDK. | +| [getDownloadedManifest](get-downloaded-manifest.md) | [androidJvm]
abstract fun [getDownloadedManifest](get-downloaded-manifest.md)(appId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [MiniAppManifest](../-mini-app-manifest/index.md)?
Get the currently downloaded manifest information e.g. required and optional permissions. | +| [getMiniAppInfoByPreviewCode](get-mini-app-info-by-preview-code.md) | [androidJvm]
abstract suspend fun [getMiniAppInfoByPreviewCode](get-mini-app-info-by-preview-code.md)(previewCode: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [PreviewMiniAppInfo](../-preview-mini-app-info/index.md)
Fetches MiniappInfo by preview code. | +| [getMiniAppManifest](get-mini-app-manifest.md) | [androidJvm]
abstract suspend fun [getMiniAppManifest](get-mini-app-manifest.md)(appId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), versionId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), languageCode: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = ""): [MiniAppManifest](../-mini-app-manifest/index.md)
Get the manifest information e.g. required and optional permissions. | +| [isMiniAppCacheAvailable](is-mini-app-cache-available.md) | [androidJvm]
abstract fun [isMiniAppCacheAvailable](is-mini-app-cache-available.md)(miniAppId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), versionId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Check and return TRUE if the MiniApp is available for a given miniAppId and versionId. | +| [listDownloadedWithCustomPermissions](list-downloaded-with-custom-permissions.md) | [androidJvm]
abstract fun [listDownloadedWithCustomPermissions](list-downloaded-with-custom-permissions.md)(): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[Pair](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)<[MiniAppInfo](../-mini-app-info/index.md), [MiniAppCustomPermission](../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission/index.md)>>
lists out the mini applications available with custom permissions in cache. | +| [listMiniApp](list-mini-app.md) | [androidJvm]
abstract suspend fun [listMiniApp](list-mini-app.md)(): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[MiniAppInfo](../-mini-app-info/index.md)>
Fetches and lists out the mini applications available in the MiniApp Ecosystem. | +| [setCustomPermissions](set-custom-permissions.md) | [androidJvm]
abstract fun [setCustomPermissions](set-custom-permissions.md)(miniAppCustomPermission: [MiniAppCustomPermission](../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission/index.md))
Store custom permissions with grant results per MiniApp inside this SDK. | +| [unzipBundle](unzip-bundle.md) | [androidJvm]
abstract suspend fun [unzipBundle](unzip-bundle.md)(fileName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), miniAppId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), versionId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), completionHandler: (success: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), [MiniAppSdkException](../-mini-app-sdk-exception/index.md)?) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)? = null)
unzip and store a MiniApp bundle from asset folder of host app. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/is-mini-app-cache-available.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/is-mini-app-cache-available.md new file mode 100644 index 000000000..e8db1fa2e --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/is-mini-app-cache-available.md @@ -0,0 +1,17 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniApp](index.md)/[isMiniAppCacheAvailable](is-mini-app-cache-available.md) + +# isMiniAppCacheAvailable + +[androidJvm]\ +abstract fun [isMiniAppCacheAvailable](is-mini-app-cache-available.md)(miniAppId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), versionId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Check and return TRUE if the MiniApp is available for a given miniAppId and versionId. + +## Parameters + +androidJvm + +| | | +|---|---| +| miniAppId | will be the id of the MiniApp. | +| versionId | will be the version of the MiniApp. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/list-downloaded-with-custom-permissions.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/list-downloaded-with-custom-permissions.md new file mode 100644 index 000000000..1a38d3c99 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/list-downloaded-with-custom-permissions.md @@ -0,0 +1,12 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniApp](index.md)/[listDownloadedWithCustomPermissions](list-downloaded-with-custom-permissions.md) + +# listDownloadedWithCustomPermissions + +[androidJvm]\ +abstract fun [listDownloadedWithCustomPermissions](list-downloaded-with-custom-permissions.md)(): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[Pair](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)<[MiniAppInfo](../-mini-app-info/index.md), [MiniAppCustomPermission](../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission/index.md)>> + +lists out the mini applications available with custom permissions in cache. + +#### Return + +List list of MiniApp what is downloaded and containing custom permissions data. diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/list-mini-app.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/list-mini-app.md new file mode 100644 index 000000000..ad1e5efd5 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/list-mini-app.md @@ -0,0 +1,18 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniApp](index.md)/[listMiniApp](list-mini-app.md) + +# listMiniApp + +[androidJvm]\ +abstract suspend fun [listMiniApp](list-mini-app.md)(): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[MiniAppInfo](../-mini-app-info/index.md)> + +Fetches and lists out the mini applications available in the MiniApp Ecosystem. + +#### Return + +[List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html) of type [MiniAppInfo](../-mini-app-info/index.md) when obtained successfully + +## Throws + +| | | +|---|---| +| [com.rakuten.tech.mobile.miniapp.MiniAppSdkException](../-mini-app-sdk-exception/index.md) | when fetching fails from the BE server for any reason. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/set-custom-permissions.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/set-custom-permissions.md new file mode 100644 index 000000000..dc8c1a301 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/set-custom-permissions.md @@ -0,0 +1,16 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniApp](index.md)/[setCustomPermissions](set-custom-permissions.md) + +# setCustomPermissions + +[androidJvm]\ +abstract fun [setCustomPermissions](set-custom-permissions.md)(miniAppCustomPermission: [MiniAppCustomPermission](../../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission/index.md)) + +Store custom permissions with grant results per MiniApp inside this SDK. + +## Parameters + +androidJvm + +| | | +|---|---| +| miniAppCustomPermission | the supplied custom permissions to be stored in cache. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/unzip-bundle.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/unzip-bundle.md new file mode 100644 index 000000000..74d49b873 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/unzip-bundle.md @@ -0,0 +1,19 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[MiniApp](index.md)/[unzipBundle](unzip-bundle.md) + +# unzipBundle + +[androidJvm]\ +abstract suspend fun [unzipBundle](unzip-bundle.md)(fileName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), miniAppId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), versionId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), completionHandler: (success: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), [MiniAppSdkException](../-mini-app-sdk-exception/index.md)?) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)? = null) + +unzip and store a MiniApp bundle from asset folder of host app. + +## Parameters + +androidJvm + +| | | +|---|---| +| fileName | will be the name of the file in asset folder. | +| miniAppId | will be the id of the MiniApp. | +| versionId | will be the version of the MiniApp. | +| completionHandler | callback when the bundle is successfully unzipped. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-preview-mini-app-info/-preview-mini-app-info.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-preview-mini-app-info/-preview-mini-app-info.md new file mode 100644 index 000000000..493952973 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-preview-mini-app-info/-preview-mini-app-info.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[PreviewMiniAppInfo](index.md)/[PreviewMiniAppInfo](-preview-mini-app-info.md) + +# PreviewMiniAppInfo + +[androidJvm]\ +fun [PreviewMiniAppInfo](-preview-mini-app-info.md)(host: [Host](../-host/index.md), miniapp: [MiniAppInfo](../-mini-app-info/index.md)) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-preview-mini-app-info/host.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-preview-mini-app-info/host.md new file mode 100644 index 000000000..23da929b3 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-preview-mini-app-info/host.md @@ -0,0 +1,9 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[PreviewMiniAppInfo](index.md)/[host](host.md) + +# host + +[androidJvm]\ + +@SerializedName(value = "host") + +val [host](host.md): [Host](../-host/index.md) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-preview-mini-app-info/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-preview-mini-app-info/index.md new file mode 100644 index 000000000..d527e584e --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-preview-mini-app-info/index.md @@ -0,0 +1,28 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[PreviewMiniAppInfo](index.md) + +# PreviewMiniAppInfo + +[androidJvm]\ +data class [PreviewMiniAppInfo](index.md)(host: [Host](../-host/index.md), miniapp: [MiniAppInfo](../-mini-app-info/index.md)) : [Parcelable](https://developer.android.com/reference/kotlin/android/os/Parcelable.html) + +This represents a response entity for preview code. + +## Constructors + +| | | +|---|---| +| [PreviewMiniAppInfo](-preview-mini-app-info.md) | [androidJvm]
fun [PreviewMiniAppInfo](-preview-mini-app-info.md)(host: [Host](../-host/index.md), miniapp: [MiniAppInfo](../-mini-app-info/index.md)) | + +## Functions + +| Name | Summary | +|---|---| +| [describeContents](../../com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/index.md#-1578325224%2FFunctions%2F1451286739) | [androidJvm]
abstract fun [describeContents](../../com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/index.md#-1578325224%2FFunctions%2F1451286739)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [writeToParcel](../../com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/index.md#-1754457655%2FFunctions%2F1451286739) | [androidJvm]
abstract fun [writeToParcel](../../com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/index.md#-1754457655%2FFunctions%2F1451286739)(p0: [Parcel](https://developer.android.com/reference/kotlin/android/os/Parcel.html), p1: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) | + +## Properties + +| Name | Summary | +|---|---| +| [host](host.md) | [androidJvm]
@SerializedName(value = "host")
val [host](host.md): [Host](../-host/index.md)
host identifier unique to a mini app. | +| [miniapp](miniapp.md) | [androidJvm]
@SerializedName(value = "miniapp")
val [miniapp](miniapp.md): [MiniAppInfo](../-mini-app-info/index.md)
represents a Mini App entity. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-preview-mini-app-info/miniapp.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-preview-mini-app-info/miniapp.md new file mode 100644 index 000000000..11ae73c68 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-preview-mini-app-info/miniapp.md @@ -0,0 +1,9 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[PreviewMiniAppInfo](index.md)/[miniapp](miniapp.md) + +# miniapp + +[androidJvm]\ + +@SerializedName(value = "miniapp") + +val [miniapp](miniapp.md): [MiniAppInfo](../-mini-app-info/index.md) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-required-permissions-not-granted-exception/-required-permissions-not-granted-exception.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-required-permissions-not-granted-exception/-required-permissions-not-granted-exception.md new file mode 100644 index 000000000..bc06af109 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-required-permissions-not-granted-exception/-required-permissions-not-granted-exception.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[RequiredPermissionsNotGrantedException](index.md)/[RequiredPermissionsNotGrantedException](-required-permissions-not-granted-exception.md) + +# RequiredPermissionsNotGrantedException + +[androidJvm]\ +fun [RequiredPermissionsNotGrantedException](-required-permissions-not-granted-exception.md)(appId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), versionId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-required-permissions-not-granted-exception/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-required-permissions-not-granted-exception/index.md new file mode 100644 index 000000000..89d56087c --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-required-permissions-not-granted-exception/index.md @@ -0,0 +1,34 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[RequiredPermissionsNotGrantedException](index.md) + +# RequiredPermissionsNotGrantedException + +[androidJvm]\ +class [RequiredPermissionsNotGrantedException](index.md)(appId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), versionId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) : [MiniAppSdkException](../-mini-app-sdk-exception/index.md) + +Exception which is thrown when the required permissions of the manifest are not granted. + +## Constructors + +| | | +|---|---| +| [RequiredPermissionsNotGrantedException](-required-permissions-not-granted-exception.md) | [androidJvm]
fun [RequiredPermissionsNotGrantedException](-required-permissions-not-granted-exception.md)(appId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), versionId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) | + +## Functions + +| Name | Summary | +|---|---| +| [addSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#282858770%2FFunctions%2F1451286739) | [androidJvm]
fun [addSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#282858770%2FFunctions%2F1451286739)(p0: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) | +| [fillInStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1102069925%2FFunctions%2F1451286739) | [androidJvm]
open fun [fillInStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1102069925%2FFunctions%2F1451286739)(): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) | +| [getLocalizedMessage](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1043865560%2FFunctions%2F1451286739) | [androidJvm]
open fun [getLocalizedMessage](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1043865560%2FFunctions%2F1451286739)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [getStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2050903719%2FFunctions%2F1451286739) | [androidJvm]
open fun [getStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2050903719%2FFunctions%2F1451286739)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[StackTraceElement](https://developer.android.com/reference/kotlin/java/lang/StackTraceElement.html)> | +| [getSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#672492560%2FFunctions%2F1451286739) | [androidJvm]
fun [getSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#672492560%2FFunctions%2F1451286739)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)> | +| [initCause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-418225042%2FFunctions%2F1451286739) | [androidJvm]
open fun [initCause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-418225042%2FFunctions%2F1451286739)(p0: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) | +| [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1769529168%2FFunctions%2F1451286739) | [androidJvm]
open fun [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1769529168%2FFunctions%2F1451286739)()
open fun [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1841853697%2FFunctions%2F1451286739)(p0: [PrintStream](https://developer.android.com/reference/kotlin/java/io/PrintStream.html))
open fun [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1175535278%2FFunctions%2F1451286739)(p0: [PrintWriter](https://developer.android.com/reference/kotlin/java/io/PrintWriter.html)) | +| [setStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2135801318%2FFunctions%2F1451286739) | [androidJvm]
open fun [setStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2135801318%2FFunctions%2F1451286739)(p0: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[StackTraceElement](https://developer.android.com/reference/kotlin/java/lang/StackTraceElement.html)>) | + +## Properties + +| Name | Summary | +|---|---| +| [cause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-654012527%2FProperties%2F1451286739) | [androidJvm]
open val [cause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-654012527%2FProperties%2F1451286739): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? | +| [message](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1824300659%2FProperties%2F1451286739) | [androidJvm]
open val [message](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1824300659%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-s-s-l-certificate-pinning-exception/-s-s-l-certificate-pinning-exception.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-s-s-l-certificate-pinning-exception/-s-s-l-certificate-pinning-exception.md new file mode 100644 index 000000000..3258a04a9 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-s-s-l-certificate-pinning-exception/-s-s-l-certificate-pinning-exception.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[SSLCertificatePinningException](index.md)/[SSLCertificatePinningException](-s-s-l-certificate-pinning-exception.md) + +# SSLCertificatePinningException + +[androidJvm]\ +fun [SSLCertificatePinningException](-s-s-l-certificate-pinning-exception.md)(serverMessage: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-s-s-l-certificate-pinning-exception/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-s-s-l-certificate-pinning-exception/index.md new file mode 100644 index 000000000..102f536c8 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-s-s-l-certificate-pinning-exception/index.md @@ -0,0 +1,34 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[SSLCertificatePinningException](index.md) + +# SSLCertificatePinningException + +[androidJvm]\ +class [SSLCertificatePinningException](index.md)(serverMessage: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) : [MiniAppSdkException](../-mini-app-sdk-exception/index.md) + +Exception which is thrown when the public key used for ssl pinning is mismatched. + +## Constructors + +| | | +|---|---| +| [SSLCertificatePinningException](-s-s-l-certificate-pinning-exception.md) | [androidJvm]
fun [SSLCertificatePinningException](-s-s-l-certificate-pinning-exception.md)(serverMessage: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) | + +## Functions + +| Name | Summary | +|---|---| +| [addSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#282858770%2FFunctions%2F1451286739) | [androidJvm]
fun [addSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#282858770%2FFunctions%2F1451286739)(p0: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) | +| [fillInStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1102069925%2FFunctions%2F1451286739) | [androidJvm]
open fun [fillInStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1102069925%2FFunctions%2F1451286739)(): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) | +| [getLocalizedMessage](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1043865560%2FFunctions%2F1451286739) | [androidJvm]
open fun [getLocalizedMessage](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1043865560%2FFunctions%2F1451286739)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [getStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2050903719%2FFunctions%2F1451286739) | [androidJvm]
open fun [getStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2050903719%2FFunctions%2F1451286739)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[StackTraceElement](https://developer.android.com/reference/kotlin/java/lang/StackTraceElement.html)> | +| [getSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#672492560%2FFunctions%2F1451286739) | [androidJvm]
fun [getSuppressed](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#672492560%2FFunctions%2F1451286739)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)> | +| [initCause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-418225042%2FFunctions%2F1451286739) | [androidJvm]
open fun [initCause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-418225042%2FFunctions%2F1451286739)(p0: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) | +| [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1769529168%2FFunctions%2F1451286739) | [androidJvm]
open fun [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-1769529168%2FFunctions%2F1451286739)()
open fun [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1841853697%2FFunctions%2F1451286739)(p0: [PrintStream](https://developer.android.com/reference/kotlin/java/io/PrintStream.html))
open fun [printStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1175535278%2FFunctions%2F1451286739)(p0: [PrintWriter](https://developer.android.com/reference/kotlin/java/io/PrintWriter.html)) | +| [setStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2135801318%2FFunctions%2F1451286739) | [androidJvm]
open fun [setStackTrace](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#2135801318%2FFunctions%2F1451286739)(p0: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[StackTraceElement](https://developer.android.com/reference/kotlin/java/lang/StackTraceElement.html)>) | + +## Properties + +| Name | Summary | +|---|---| +| [cause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-654012527%2FProperties%2F1451286739) | [androidJvm]
open val [cause](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#-654012527%2FProperties%2F1451286739): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? | +| [message](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1824300659%2FProperties%2F1451286739) | [androidJvm]
open val [message](../../com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md#1824300659%2FProperties%2F1451286739): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-version/-version.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-version/-version.md new file mode 100644 index 000000000..4515c196c --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-version/-version.md @@ -0,0 +1,6 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[Version](index.md)/[Version](-version.md) + +# Version + +[androidJvm]\ +fun [Version](-version.md)(versionTag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), versionId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-version/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-version/index.md new file mode 100644 index 000000000..e53347f2b --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-version/index.md @@ -0,0 +1,28 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[Version](index.md) + +# Version + +[androidJvm]\ +data class [Version](index.md)(versionTag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), versionId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) : [Parcelable](https://developer.android.com/reference/kotlin/android/os/Parcelable.html) + +This represents a version entity of a Mini App. + +## Constructors + +| | | +|---|---| +| [Version](-version.md) | [androidJvm]
fun [Version](-version.md)(versionTag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), versionId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) | + +## Functions + +| Name | Summary | +|---|---| +| [describeContents](../../com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/index.md#-1578325224%2FFunctions%2F1451286739) | [androidJvm]
abstract fun [describeContents](../../com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/index.md#-1578325224%2FFunctions%2F1451286739)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [writeToParcel](../../com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/index.md#-1754457655%2FFunctions%2F1451286739) | [androidJvm]
abstract fun [writeToParcel](../../com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/index.md#-1754457655%2FFunctions%2F1451286739)(p0: [Parcel](https://developer.android.com/reference/kotlin/android/os/Parcel.html), p1: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) | + +## Properties + +| Name | Summary | +|---|---| +| [versionId](version-id.md) | [androidJvm]
@SerializedName(value = "versionId")
val [versionId](version-id.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Version identifier of the mini app. | +| [versionTag](version-tag.md) | [androidJvm]
@SerializedName(value = "versionTag")
val [versionTag](version-tag.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Version information of the mini app. | diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-version/version-id.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-version/version-id.md new file mode 100644 index 000000000..181ae90e5 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-version/version-id.md @@ -0,0 +1,9 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[Version](index.md)/[versionId](version-id.md) + +# versionId + +[androidJvm]\ + +@SerializedName(value = "versionId") + +val [versionId](version-id.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-version/version-tag.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-version/version-tag.md new file mode 100644 index 000000000..0018b7ac2 --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/-version/version-tag.md @@ -0,0 +1,9 @@ +//[miniapp](../../../index.md)/[com.rakuten.tech.mobile.miniapp](../index.md)/[Version](index.md)/[versionTag](version-tag.md) + +# versionTag + +[androidJvm]\ + +@SerializedName(value = "versionTag") + +val [versionTag](version-tag.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/index.md b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/index.md new file mode 100644 index 000000000..b6d6bcf0d --- /dev/null +++ b/docs/5.6/api/miniapp/com.rakuten.tech.mobile.miniapp/index.md @@ -0,0 +1,28 @@ +//[miniapp](../../index.md)/[com.rakuten.tech.mobile.miniapp](index.md) + +# Package com.rakuten.tech.mobile.miniapp + +## Types + +| Name | Summary | +|---|---| +| [Host](-host/index.md) | [androidJvm]
data class [Host](-host/index.md)(id: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), subscriptionKey: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) : [Parcelable](https://developer.android.com/reference/kotlin/android/os/Parcelable.html)
This represents a host entity of a Mini App. | +| [InvalidMiniAppInfoException](-invalid-mini-app-info-exception/index.md) | [androidJvm]
class [InvalidMiniAppInfoException](-invalid-mini-app-info-exception/index.md) : [MiniAppSdkException](-mini-app-sdk-exception/index.md)
Exception which is thrown when the the appId or versionId is empty. | +| [MiniApp](-mini-app/index.md) | [androidJvm]
abstract class [MiniApp](-mini-app/index.md)
This represents the contract between the consuming application and the SDK by which operations in the mini app ecosystem are exposed. Should be accessed via [MiniApp.instance](-mini-app/-companion/instance.md). | +| [MiniAppBundleNotFoundException](-mini-app-bundle-not-found-exception/index.md) | [androidJvm]
class [MiniAppBundleNotFoundException](-mini-app-bundle-not-found-exception/index.md) : [MiniAppSdkException](-mini-app-sdk-exception/index.md)
Exception which is thrown when the MiniApp Bundle is missing. | +| [MiniAppDisplay](-mini-app-display/index.md) | [androidJvm]
interface [MiniAppDisplay](-mini-app-display/index.md) : [LifecycleObserver](https://developer.android.com/reference/kotlin/androidx/lifecycle/LifecycleObserver.html)
This represents the contract by which the host app can interact with the display unit of the mini app. This contract complies to Android's [LifecycleObserver](https://developer.android.com/reference/kotlin/androidx/lifecycle/LifecycleObserver.html) contract, and when made to observe the lifecycle, it automatically clears up the view state and any services registered with. | +| [MiniAppHasCorruptedException](-mini-app-has-corrupted-exception/index.md) | [androidJvm]
class [MiniAppHasCorruptedException](-mini-app-has-corrupted-exception/index.md)(appId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) : [MiniAppSdkException](-mini-app-sdk-exception/index.md)
Exception which is thrown when the MiniApp bundle is corrupted. | +| [MiniAppHasNoPublishedVersionException](-mini-app-has-no-published-version-exception/index.md) | [androidJvm]
class [MiniAppHasNoPublishedVersionException](-mini-app-has-no-published-version-exception/index.md)(appId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) : [MiniAppSdkException](-mini-app-sdk-exception/index.md)
Exception which is thrown when the server returns no published versions for the provided mini app ID. | +| [MiniAppHostException](-mini-app-host-exception/index.md) | [androidJvm]
class [MiniAppHostException](-mini-app-host-exception/index.md)(serverMessage: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) : [MiniAppSdkException](-mini-app-sdk-exception/index.md)
Exception which is thrown when the provided project ID does not have any mini app exist on the server. | +| [MiniAppInfo](-mini-app-info/index.md) | [androidJvm]
data class [MiniAppInfo](-mini-app-info/index.md)(id: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), displayName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), icon: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), version: [Version](-version/index.md), promotionalImageUrl: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, promotionalText: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) : [Parcelable](https://developer.android.com/reference/kotlin/android/os/Parcelable.html)
This represents a Mini App entity. | +| [MiniAppManifest](-mini-app-manifest/index.md) | [androidJvm]
data class [MiniAppManifest](-mini-app-manifest/index.md)(requiredPermissions: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[Pair](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)<[MiniAppCustomPermissionType](../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/index.md), [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>>, optionalPermissions: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[Pair](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html)<[MiniAppCustomPermissionType](../com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/index.md), [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>>, accessTokenPermissions: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[AccessTokenScope](../com.rakuten.tech.mobile.miniapp.permission/-access-token-scope/index.md)>, customMetaData: [Map](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>, versionId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html))
A data class to represent data in the mini app's manifest. | +| [MiniAppNetException](-mini-app-net-exception/index.md) | [androidJvm]
class [MiniAppNetException](-mini-app-net-exception/index.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), cause: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?) : [MiniAppSdkException](-mini-app-sdk-exception/index.md)
Exception indicating that there was an issue with network connectivity. | +| [MiniAppNotFoundException](-mini-app-not-found-exception/index.md) | [androidJvm]
class [MiniAppNotFoundException](-mini-app-not-found-exception/index.md)(serverMessage: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) : [MiniAppSdkException](-mini-app-sdk-exception/index.md)
Exception which is thrown when the provided project ID does not have any mini app exist on the server. | +| [MiniAppSdkConfig](-mini-app-sdk-config/index.md) | [androidJvm]
data class [MiniAppSdkConfig](-mini-app-sdk-config/index.md)(baseUrl: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), rasProjectId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), subscriptionKey: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), hostAppVersionId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), hostAppUserAgentInfo: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), isPreviewMode: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), requireSignatureVerification: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), miniAppAnalyticsConfigList: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[MiniAppAnalyticsConfig](../com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/index.md)>, sslPinningPublicKeyList: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>, enableH5Ads: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), maxStorageSizeLimitInBytes: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) : [Parcelable](https://developer.android.com/reference/kotlin/android/os/Parcelable.html)
This represents the configuration settings for the Mini App SDK. | +| [MiniAppSdkException](-mini-app-sdk-exception/index.md) | [androidJvm]
open class [MiniAppSdkException](-mini-app-sdk-exception/index.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), cause: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?) : [Exception](https://developer.android.com/reference/kotlin/java/lang/Exception.html)
A custom exception class which treats the purpose of providing error information to the consumer app in an unified way. | +| [MiniAppTooManyRequestsError](-mini-app-too-many-requests-error/index.md) | [androidJvm]
class [MiniAppTooManyRequestsError](-mini-app-too-many-requests-error/index.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) : [MiniAppSdkException](-mini-app-sdk-exception/index.md)
Exception which is thrown when there are too many requests for a MiniApp. | +| [MiniAppVerificationException](-mini-app-verification-exception/index.md) | [androidJvm]
class [MiniAppVerificationException](-mini-app-verification-exception/index.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) : [MiniAppSdkException](-mini-app-sdk-exception/index.md)
Exception which is thrown when cannot verify device keystore. | +| [PreviewMiniAppInfo](-preview-mini-app-info/index.md) | [androidJvm]
data class [PreviewMiniAppInfo](-preview-mini-app-info/index.md)(host: [Host](-host/index.md), miniapp: [MiniAppInfo](-mini-app-info/index.md)) : [Parcelable](https://developer.android.com/reference/kotlin/android/os/Parcelable.html)
This represents a response entity for preview code. | +| [RequiredPermissionsNotGrantedException](-required-permissions-not-granted-exception/index.md) | [androidJvm]
class [RequiredPermissionsNotGrantedException](-required-permissions-not-granted-exception/index.md)(appId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), versionId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) : [MiniAppSdkException](-mini-app-sdk-exception/index.md)
Exception which is thrown when the required permissions of the manifest are not granted. | +| [SSLCertificatePinningException](-s-s-l-certificate-pinning-exception/index.md) | [androidJvm]
class [SSLCertificatePinningException](-s-s-l-certificate-pinning-exception/index.md)(serverMessage: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) : [MiniAppSdkException](-mini-app-sdk-exception/index.md)
Exception which is thrown when the public key used for ssl pinning is mismatched. | +| [Version](-version/index.md) | [androidJvm]
data class [Version](-version/index.md)(versionTag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), versionId: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) : [Parcelable](https://developer.android.com/reference/kotlin/android/os/Parcelable.html)
This represents a version entity of a Mini App. | diff --git a/docs/5.6/api/miniapp/package-list b/docs/5.6/api/miniapp/package-list new file mode 100644 index 000000000..8af9ee68e --- /dev/null +++ b/docs/5.6/api/miniapp/package-list @@ -0,0 +1,378 @@ +$dokka.format:gfm-v1 +$dokka.linkExtension:md +$dokka.location:com.rakuten.tech.mobile.miniapp.analytics////PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.analytics/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.analytics/MAAnalyticsActionType.ADD///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-action-type/-a-d-d/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.analytics/MAAnalyticsActionType.CHANGE///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-action-type/-c-h-a-n-g-e/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.analytics/MAAnalyticsActionType.CLOSE///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-action-type/-c-l-o-s-e/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.analytics/MAAnalyticsActionType.DELETE///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-action-type/-d-e-l-e-t-e/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.analytics/MAAnalyticsActionType.OPEN///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-action-type/-o-p-e-n/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.analytics/MAAnalyticsActionType///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-action-type/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.analytics/MAAnalyticsEventType.APPEAR///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-event-type/-a-p-p-e-a-r/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.analytics/MAAnalyticsEventType.CLICK///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-event-type/-c-l-i-c-k/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.analytics/MAAnalyticsEventType.CUSTOM///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-event-type/-c-u-s-t-o-m/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.analytics/MAAnalyticsEventType.ERROR///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-event-type/-e-r-r-o-r/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.analytics/MAAnalyticsEventType///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-event-type/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.analytics/MAAnalyticsInfo///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.analytics/MAAnalyticsInfo/MAAnalyticsInfo/#com.rakuten.tech.mobile.miniapp.analytics.MAAnalyticsEventType#com.rakuten.tech.mobile.miniapp.analytics.MAAnalyticsActionType#kotlin.String#kotlin.String#kotlin.String#kotlin.String/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/-m-a-analytics-info.md +$dokka.location:com.rakuten.tech.mobile.miniapp.analytics/MAAnalyticsInfo/actionType/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/action-type.md +$dokka.location:com.rakuten.tech.mobile.miniapp.analytics/MAAnalyticsInfo/componentName/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/component-name.md +$dokka.location:com.rakuten.tech.mobile.miniapp.analytics/MAAnalyticsInfo/data/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/data.md +$dokka.location:com.rakuten.tech.mobile.miniapp.analytics/MAAnalyticsInfo/elementType/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/element-type.md +$dokka.location:com.rakuten.tech.mobile.miniapp.analytics/MAAnalyticsInfo/eventType/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/event-type.md +$dokka.location:com.rakuten.tech.mobile.miniapp.analytics/MAAnalyticsInfo/pageName/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-m-a-analytics-info/page-name.md +$dokka.location:com.rakuten.tech.mobile.miniapp.analytics/MiniAppAnalyticsConfig///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.analytics/MiniAppAnalyticsConfig/MiniAppAnalyticsConfig/#kotlin.Int#kotlin.Int/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/-mini-app-analytics-config.md +$dokka.location:com.rakuten.tech.mobile.miniapp.analytics/MiniAppAnalyticsConfig/acc/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/acc.md +$dokka.location:com.rakuten.tech.mobile.miniapp.analytics/MiniAppAnalyticsConfig/aid/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.analytics/-mini-app-analytics-config/aid.md +$dokka.location:com.rakuten.tech.mobile.miniapp.closealert////PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.closealert/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.closealert/MiniAppCloseAlertInfo///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.closealert/-mini-app-close-alert-info/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.closealert/MiniAppCloseAlertInfo/MiniAppCloseAlertInfo/#kotlin.Boolean#kotlin.String#kotlin.String/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.closealert/-mini-app-close-alert-info/-mini-app-close-alert-info.md +$dokka.location:com.rakuten.tech.mobile.miniapp.closealert/MiniAppCloseAlertInfo/description/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.closealert/-mini-app-close-alert-info/description.md +$dokka.location:com.rakuten.tech.mobile.miniapp.closealert/MiniAppCloseAlertInfo/shouldDisplay/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.closealert/-mini-app-close-alert-info/should-display.md +$dokka.location:com.rakuten.tech.mobile.miniapp.closealert/MiniAppCloseAlertInfo/title/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.closealert/-mini-app-close-alert-info/title.md +$dokka.location:com.rakuten.tech.mobile.miniapp.display////PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.display/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.display/MiniAppDefaultFileProvider///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.display/-mini-app-default-file-provider/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.display/MiniAppDefaultFileProvider/MiniAppDefaultFileProvider/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.display/-mini-app-default-file-provider/-mini-app-default-file-provider.md +$dokka.location:com.rakuten.tech.mobile.miniapp.errors////PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.errors/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.errors/MiniAppAccessTokenError.Companion///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/-companion/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.errors/MiniAppAccessTokenError.Companion/audienceNotSupportedError/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/-companion/audience-not-supported-error.md +$dokka.location:com.rakuten.tech.mobile.miniapp.errors/MiniAppAccessTokenError.Companion/authorizationFailureError/#kotlin.String/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/-companion/authorization-failure-error.md +$dokka.location:com.rakuten.tech.mobile.miniapp.errors/MiniAppAccessTokenError.Companion/custom/#kotlin.String/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/-companion/custom.md +$dokka.location:com.rakuten.tech.mobile.miniapp.errors/MiniAppAccessTokenError.Companion/scopesNotSupportedError/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/-companion/scopes-not-supported-error.md +$dokka.location:com.rakuten.tech.mobile.miniapp.errors/MiniAppAccessTokenError///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.errors/MiniAppAccessTokenError/MiniAppAccessTokenError/#kotlin.String?#kotlin.String?/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/-mini-app-access-token-error.md +$dokka.location:com.rakuten.tech.mobile.miniapp.errors/MiniAppAccessTokenError/message/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/message.md +$dokka.location:com.rakuten.tech.mobile.miniapp.errors/MiniAppAccessTokenError/type/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-access-token-error/type.md +$dokka.location:com.rakuten.tech.mobile.miniapp.errors/MiniAppBridgeError///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-bridge-error/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.errors/MiniAppBridgeError/MiniAppBridgeError/#kotlin.String?#kotlin.String?/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-bridge-error/-mini-app-bridge-error.md +$dokka.location:com.rakuten.tech.mobile.miniapp.errors/MiniAppDownloadFileError.Companion///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/-companion/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.errors/MiniAppDownloadFileError.Companion/downloadFailedError/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/-companion/download-failed-error.md +$dokka.location:com.rakuten.tech.mobile.miniapp.errors/MiniAppDownloadFileError.Companion/invalidUrlError/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/-companion/invalid-url-error.md +$dokka.location:com.rakuten.tech.mobile.miniapp.errors/MiniAppDownloadFileError.Companion/saveFailureError/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/-companion/save-failure-error.md +$dokka.location:com.rakuten.tech.mobile.miniapp.errors/MiniAppDownloadFileError///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.errors/MiniAppDownloadFileError/MiniAppDownloadFileError/#kotlin.String?#kotlin.String?#kotlin.Int?/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/-mini-app-download-file-error.md +$dokka.location:com.rakuten.tech.mobile.miniapp.errors/MiniAppDownloadFileError/code/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/code.md +$dokka.location:com.rakuten.tech.mobile.miniapp.errors/MiniAppDownloadFileError/message/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/message.md +$dokka.location:com.rakuten.tech.mobile.miniapp.errors/MiniAppDownloadFileError/type/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-download-file-error/type.md +$dokka.location:com.rakuten.tech.mobile.miniapp.errors/MiniAppPointsError.Companion///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-points-error/-companion/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.errors/MiniAppPointsError.Companion/custom/#kotlin.String/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-points-error/-companion/custom.md +$dokka.location:com.rakuten.tech.mobile.miniapp.errors/MiniAppPointsError///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-points-error/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.errors/MiniAppPointsError/MiniAppPointsError/#kotlin.String?#kotlin.String?/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-points-error/-mini-app-points-error.md +$dokka.location:com.rakuten.tech.mobile.miniapp.errors/MiniAppPointsError/message/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-points-error/message.md +$dokka.location:com.rakuten.tech.mobile.miniapp.errors/MiniAppPointsError/type/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.errors/-mini-app-points-error/type.md +$dokka.location:com.rakuten.tech.mobile.miniapp.file////PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.file/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.file/MiniAppCameraPermissionDispatcher///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-camera-permission-dispatcher/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.file/MiniAppCameraPermissionDispatcher/getCameraPermission/#kotlin.Function1[kotlin.Boolean,kotlin.Unit]/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-camera-permission-dispatcher/get-camera-permission.md +$dokka.location:com.rakuten.tech.mobile.miniapp.file/MiniAppCameraPermissionDispatcher/requestCameraPermission/#com.rakuten.tech.mobile.miniapp.permission.MiniAppDevicePermissionType#kotlin.Function1[kotlin.Boolean,kotlin.Unit]/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-camera-permission-dispatcher/request-camera-permission.md +$dokka.location:com.rakuten.tech.mobile.miniapp.file/MiniAppFileChooser///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.file/MiniAppFileChooser/onShowFileChooser/#android.webkit.ValueCallback[kotlin.Array[android.net.Uri]]?#android.webkit.WebChromeClient.FileChooserParams?#android.content.Context/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser/on-show-file-chooser.md +$dokka.location:com.rakuten.tech.mobile.miniapp.file/MiniAppFileChooserDefault///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser-default/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.file/MiniAppFileChooserDefault/MiniAppFileChooserDefault/#kotlin.Int#com.rakuten.tech.mobile.miniapp.file.MiniAppCameraPermissionDispatcher?/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser-default/-mini-app-file-chooser-default.md +$dokka.location:com.rakuten.tech.mobile.miniapp.file/MiniAppFileChooserDefault/onCancel/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser-default/on-cancel.md +$dokka.location:com.rakuten.tech.mobile.miniapp.file/MiniAppFileChooserDefault/onReceivedFiles/#android.content.Intent?/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser-default/on-received-files.md +$dokka.location:com.rakuten.tech.mobile.miniapp.file/MiniAppFileChooserDefault/onShowFileChooser/#android.webkit.ValueCallback[kotlin.Array[android.net.Uri]]?#android.webkit.WebChromeClient.FileChooserParams?#android.content.Context/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser-default/on-show-file-chooser.md +$dokka.location:com.rakuten.tech.mobile.miniapp.file/MiniAppFileChooserDefault/requestCode/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser-default/request-code.md +$dokka.location:com.rakuten.tech.mobile.miniapp.file/MiniAppFileDownloader///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.file/MiniAppFileDownloader/onStartFileDownload/#kotlin.String#kotlin.String#kotlin.collections.Map[kotlin.String,kotlin.String]#kotlin.Function1[kotlin.String,kotlin.Unit]#kotlin.Function1[com.rakuten.tech.mobile.miniapp.errors.MiniAppDownloadFileError,kotlin.Unit]/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader/on-start-file-download.md +$dokka.location:com.rakuten.tech.mobile.miniapp.file/MiniAppFileDownloaderDefault///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader-default/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.file/MiniAppFileDownloaderDefault/MiniAppFileDownloaderDefault/#android.app.Activity#kotlin.Int/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader-default/-mini-app-file-downloader-default.md +$dokka.location:com.rakuten.tech.mobile.miniapp.file/MiniAppFileDownloaderDefault/activity/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader-default/activity.md +$dokka.location:com.rakuten.tech.mobile.miniapp.file/MiniAppFileDownloaderDefault/onCancel/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader-default/on-cancel.md +$dokka.location:com.rakuten.tech.mobile.miniapp.file/MiniAppFileDownloaderDefault/onReceivedResult/#android.net.Uri/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader-default/on-received-result.md +$dokka.location:com.rakuten.tech.mobile.miniapp.file/MiniAppFileDownloaderDefault/onStartFileDownload/#kotlin.String#kotlin.String#kotlin.collections.Map[kotlin.String,kotlin.String]#kotlin.Function1[kotlin.String,kotlin.Unit]#kotlin.Function1[com.rakuten.tech.mobile.miniapp.errors.MiniAppDownloadFileError,kotlin.Unit]/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader-default/on-start-file-download.md +$dokka.location:com.rakuten.tech.mobile.miniapp.file/MiniAppFileDownloaderDefault/requestCode/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader-default/request-code.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.chat////PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.chat/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.chat/ChatBridgeDispatcher///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.chat/-chat-bridge-dispatcher/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.chat/ChatBridgeDispatcher/sendMessageToContact/#com.rakuten.tech.mobile.miniapp.js.MessageToContact#kotlin.Function1[kotlin.String?,kotlin.Unit]#kotlin.Function1[kotlin.String,kotlin.Unit]/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.chat/-chat-bridge-dispatcher/send-message-to-contact.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.chat/ChatBridgeDispatcher/sendMessageToContactId/#kotlin.String#com.rakuten.tech.mobile.miniapp.js.MessageToContact#kotlin.Function1[kotlin.String?,kotlin.Unit]#kotlin.Function1[kotlin.String,kotlin.Unit]/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.chat/-chat-bridge-dispatcher/send-message-to-contact-id.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.chat/ChatBridgeDispatcher/sendMessageToMultipleContacts/#com.rakuten.tech.mobile.miniapp.js.MessageToContact#kotlin.Function1[kotlin.collections.List[kotlin.String]?,kotlin.Unit]#kotlin.Function1[kotlin.String,kotlin.Unit]/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.chat/-chat-bridge-dispatcher/send-message-to-multiple-contacts.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.hostenvironment////PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.hostenvironment/HostAppThemeColors///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-app-theme-colors/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.hostenvironment/HostAppThemeColors/HostAppThemeColors/#kotlin.String?#kotlin.String?/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-app-theme-colors/-host-app-theme-colors.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.hostenvironment/HostAppThemeColors/primaryColor/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-app-theme-colors/primary-color.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.hostenvironment/HostAppThemeColors/secondaryColor/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-app-theme-colors/secondary-color.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.hostenvironment/HostEnvironmentInfo///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.hostenvironment/HostEnvironmentInfo/HostEnvironmentInfo/#android.app.Activity#kotlin.String/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info/-host-environment-info.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.hostenvironment/HostEnvironmentInfo/HostEnvironmentInfo/#kotlin.String#kotlin.String#kotlin.String#kotlin.String/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info/-host-environment-info.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.hostenvironment/HostEnvironmentInfo/hostLocale/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info/host-locale.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.hostenvironment/HostEnvironmentInfo/hostVersion/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info/host-version.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.hostenvironment/HostEnvironmentInfo/platformVersion/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info/platform-version.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.hostenvironment/HostEnvironmentInfo/sdkVersion/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info/sdk-version.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.hostenvironment/HostEnvironmentInfoError.Companion///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info-error/-companion/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.hostenvironment/HostEnvironmentInfoError.Companion/custom/#kotlin.String/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info-error/-companion/custom.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.hostenvironment/HostEnvironmentInfoError///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info-error/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.hostenvironment/HostEnvironmentInfoError/HostEnvironmentInfoError/#kotlin.String?#kotlin.String?/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info-error/-host-environment-info-error.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.hostenvironment/HostEnvironmentInfoError/message/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info-error/message.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.hostenvironment/HostEnvironmentInfoError/type/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.hostenvironment/-host-environment-info-error/type.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.universalbridge////PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.universalbridge/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.universalbridge/UniversalBridgeInfo///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.universalbridge/-universal-bridge-info/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.universalbridge/UniversalBridgeInfo/UniversalBridgeInfo/#kotlin.String#kotlin.String#kotlin.String/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.universalbridge/-universal-bridge-info/-universal-bridge-info.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.universalbridge/UniversalBridgeInfo/description/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.universalbridge/-universal-bridge-info/description.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.universalbridge/UniversalBridgeInfo/key/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.universalbridge/-universal-bridge-info/key.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.universalbridge/UniversalBridgeInfo/value/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.universalbridge/-universal-bridge-info/value.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.userinfo////PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.userinfo/Contact///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-contact/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.userinfo/Contact/Contact/#kotlin.String#kotlin.String?#kotlin.String?#kotlin.collections.List[kotlin.String]?/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-contact/-contact.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.userinfo/Contact/allEmailList/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-contact/all-email-list.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.userinfo/Contact/email/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-contact/email.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.userinfo/Contact/id/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-contact/id.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.userinfo/Contact/name/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-contact/name.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.userinfo/Points///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-points/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.userinfo/Points/Points/#kotlin.Int#kotlin.Int#kotlin.Int/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-points/-points.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.userinfo/Points/cash/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-points/cash.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.userinfo/Points/standard/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-points/standard.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.userinfo/Points/term/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-points/term.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.userinfo/TokenData///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-token-data/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.userinfo/TokenData/TokenData/#kotlin.String#kotlin.Long#com.rakuten.tech.mobile.miniapp.permission.AccessTokenScope/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-token-data/-token-data.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.userinfo/TokenData/scopes/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-token-data/scopes.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.userinfo/TokenData/token/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-token-data/token.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.userinfo/TokenData/validUntil/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-token-data/valid-until.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.userinfo/UserInfoBridgeDispatcher///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-user-info-bridge-dispatcher/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.userinfo/UserInfoBridgeDispatcher/getAccessToken/#kotlin.String#com.rakuten.tech.mobile.miniapp.permission.AccessTokenScope#kotlin.Function1[com.rakuten.tech.mobile.miniapp.js.userinfo.TokenData,kotlin.Unit]#kotlin.Function1[com.rakuten.tech.mobile.miniapp.errors.MiniAppAccessTokenError,kotlin.Unit]/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-user-info-bridge-dispatcher/get-access-token.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.userinfo/UserInfoBridgeDispatcher/getContacts/#kotlin.Function1[java.util.ArrayList[com.rakuten.tech.mobile.miniapp.js.userinfo.Contact],kotlin.Unit]#kotlin.Function1[kotlin.String,kotlin.Unit]/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-user-info-bridge-dispatcher/get-contacts.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.userinfo/UserInfoBridgeDispatcher/getPoints/#kotlin.Function1[com.rakuten.tech.mobile.miniapp.js.userinfo.Points,kotlin.Unit]#kotlin.Function1[com.rakuten.tech.mobile.miniapp.errors.MiniAppPointsError,kotlin.Unit]/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-user-info-bridge-dispatcher/get-points.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.userinfo/UserInfoBridgeDispatcher/getProfilePhoto/#kotlin.Function1[kotlin.String,kotlin.Unit]#kotlin.Function1[kotlin.String,kotlin.Unit]/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-user-info-bridge-dispatcher/get-profile-photo.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js.userinfo/UserInfoBridgeDispatcher/getUserName/#kotlin.Function1[kotlin.String,kotlin.Unit]#kotlin.Function1[kotlin.String,kotlin.Unit]/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js.userinfo/-user-info-bridge-dispatcher/get-user-name.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js////PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js/MessageToContact///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js/-message-to-contact/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js/MessageToContact/MessageToContact/#kotlin.String#kotlin.String#kotlin.String#kotlin.String#kotlin.String?/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js/-message-to-contact/-message-to-contact.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js/MessageToContact/action/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js/-message-to-contact/action.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js/MessageToContact/bannerMessage/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js/-message-to-contact/banner-message.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js/MessageToContact/caption/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js/-message-to-contact/caption.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js/MessageToContact/image/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js/-message-to-contact/image.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js/MessageToContact/isEmpty/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js/-message-to-contact/is-empty.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js/MessageToContact/text/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js/-message-to-contact/text.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js/MiniAppMessageBridge///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js/MiniAppMessageBridge/MiniAppMessageBridge/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/-mini-app-message-bridge.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js/MiniAppMessageBridge/allowScreenOrientation/#kotlin.Boolean/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/allow-screen-orientation.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js/MiniAppMessageBridge/didReceiveMAAnalytics/#com.rakuten.tech.mobile.miniapp.analytics.MAAnalyticsInfo#kotlin.Function1[kotlin.String,kotlin.Unit]#kotlin.Function1[kotlin.String,kotlin.Unit]/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/did-receive-m-a-analytics.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js/MiniAppMessageBridge/dispatchNativeEvent/#com.rakuten.tech.mobile.miniapp.js.NativeEventType#kotlin.String/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/dispatch-native-event.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js/MiniAppMessageBridge/getHostAppThemeColors/#kotlin.Function1[com.rakuten.tech.mobile.miniapp.js.hostenvironment.HostAppThemeColors,kotlin.Unit]#kotlin.Function1[kotlin.String,kotlin.Unit]/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/get-host-app-theme-colors.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js/MiniAppMessageBridge/getHostEnvironmentInfo/#kotlin.Function1[com.rakuten.tech.mobile.miniapp.js.hostenvironment.HostEnvironmentInfo,kotlin.Unit]#kotlin.Function1[com.rakuten.tech.mobile.miniapp.js.hostenvironment.HostEnvironmentInfoError,kotlin.Unit]/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/get-host-environment-info.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js/MiniAppMessageBridge/getIsDarkMode/#kotlin.Function1[kotlin.Boolean,kotlin.Unit]#kotlin.Function1[kotlin.String,kotlin.Unit]/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/get-is-dark-mode.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js/MiniAppMessageBridge/getMauid/#kotlin.Function1[kotlin.String,kotlin.Unit]#kotlin.Function1[kotlin.String,kotlin.Unit]/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/get-mauid.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js/MiniAppMessageBridge/getMessagingUniqueId/#kotlin.Function1[kotlin.String,kotlin.Unit]#kotlin.Function1[kotlin.String,kotlin.Unit]/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/get-messaging-unique-id.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js/MiniAppMessageBridge/getUniqueId/#kotlin.Function1[kotlin.String,kotlin.Unit]#kotlin.Function1[kotlin.String,kotlin.Unit]/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/get-unique-id.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js/MiniAppMessageBridge/miniAppShouldClose/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/mini-app-should-close.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js/MiniAppMessageBridge/postMessage/#kotlin.String/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/post-message.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js/MiniAppMessageBridge/requestCustomPermissions/#kotlin.collections.List[kotlin.Pair[com.rakuten.tech.mobile.miniapp.permission.MiniAppCustomPermissionType,kotlin.String]]#kotlin.Function1[kotlin.collections.List[kotlin.Pair[com.rakuten.tech.mobile.miniapp.permission.MiniAppCustomPermissionType,com.rakuten.tech.mobile.miniapp.permission.MiniAppCustomPermissionResult]],kotlin.Unit]/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/request-custom-permissions.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js/MiniAppMessageBridge/requestDevicePermission/#com.rakuten.tech.mobile.miniapp.permission.MiniAppDevicePermissionType#kotlin.Function1[kotlin.Boolean,kotlin.Unit]/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/request-device-permission.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js/MiniAppMessageBridge/sendInfoToHostApp/#com.rakuten.tech.mobile.miniapp.js.universalbridge.UniversalBridgeInfo#kotlin.Function1[kotlin.String,kotlin.Unit]#kotlin.Function1[kotlin.String,kotlin.Unit]/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/send-info-to-host-app.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js/MiniAppMessageBridge/sendJsonToHostApp/#kotlin.String#kotlin.Function1[kotlin.String,kotlin.Unit]#kotlin.Function1[kotlin.String,kotlin.Unit]/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/send-json-to-host-app.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js/MiniAppMessageBridge/setAdMobDisplayer/#com.rakuten.tech.mobile.miniapp.ads.MiniAppAdDisplayer/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/set-ad-mob-displayer.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js/MiniAppMessageBridge/setChatBridgeDispatcher/#com.rakuten.tech.mobile.miniapp.js.chat.ChatBridgeDispatcher/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/set-chat-bridge-dispatcher.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js/MiniAppMessageBridge/setInAppPurchaseProvider/#com.rakuten.tech.mobile.miniapp.iap.InAppPurchaseProvider/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/set-in-app-purchase-provider.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js/MiniAppMessageBridge/setMiniAppCloseListener/#kotlin.Function1[kotlin.Boolean,kotlin.Unit]/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/set-mini-app-close-listener.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js/MiniAppMessageBridge/setMiniAppFileDownloader/#com.rakuten.tech.mobile.miniapp.file.MiniAppFileDownloader/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/set-mini-app-file-downloader.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js/MiniAppMessageBridge/setUserInfoBridgeDispatcher/#com.rakuten.tech.mobile.miniapp.js.userinfo.UserInfoBridgeDispatcher/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/set-user-info-bridge-dispatcher.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js/MiniAppMessageBridge/shareContent/#kotlin.String#kotlin.Function2[kotlin.Boolean,kotlin.String?,kotlin.Unit]/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/share-content.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js/NativeEventType.EXTERNAL_WEBVIEW_CLOSE///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js/-native-event-type/-e-x-t-e-r-n-a-l_-w-e-b-v-i-e-w_-c-l-o-s-e/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js/NativeEventType.MINIAPP_ON_PAUSE///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js/-native-event-type/-m-i-n-i-a-p-p_-o-n_-p-a-u-s-e/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js/NativeEventType.MINIAPP_ON_RESUME///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js/-native-event-type/-m-i-n-i-a-p-p_-o-n_-r-e-s-u-m-e/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js/NativeEventType.MINIAPP_RECEIVE_JSON_INFO///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js/-native-event-type/-m-i-n-i-a-p-p_-r-e-c-e-i-v-e_-j-s-o-n_-i-n-f-o/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js/NativeEventType.MINIAPP_SECURE_STORAGE_LOAD_ERROR///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js/-native-event-type/-m-i-n-i-a-p-p_-s-e-c-u-r-e_-s-t-o-r-a-g-e_-l-o-a-d_-e-r-r-o-r/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js/NativeEventType.MINIAPP_SECURE_STORAGE_READY///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js/-native-event-type/-m-i-n-i-a-p-p_-s-e-c-u-r-e_-s-t-o-r-a-g-e_-r-e-a-d-y/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js/NativeEventType///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js/-native-event-type/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.js/NativeEventType/value/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.js/-native-event-type/value.md +$dokka.location:com.rakuten.tech.mobile.miniapp.navigator////PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.navigator/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.navigator/ExternalResultHandler///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-external-result-handler/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.navigator/ExternalResultHandler/ExternalResultHandler/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-external-result-handler/-external-result-handler.md +$dokka.location:com.rakuten.tech.mobile.miniapp.navigator/ExternalResultHandler/emitResult/#android.content.Intent/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-external-result-handler/emit-result.md +$dokka.location:com.rakuten.tech.mobile.miniapp.navigator/ExternalResultHandler/emitResult/#kotlin.String/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-external-result-handler/emit-result.md +$dokka.location:com.rakuten.tech.mobile.miniapp.navigator/MiniAppDownloadNavigator///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-download-navigator/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.navigator/MiniAppDownloadNavigator/onFileDownloadStart/#kotlin.String#kotlin.String#kotlin.String#kotlin.String#kotlin.Long/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-download-navigator/on-file-download-start.md +$dokka.location:com.rakuten.tech.mobile.miniapp.navigator/MiniAppExternalUrlLoader.Companion///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-external-url-loader/-companion/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.navigator/MiniAppExternalUrlLoader.Companion/loaderWithId/#kotlin.String#android.app.Activity?/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-external-url-loader/-companion/loader-with-id.md +$dokka.location:com.rakuten.tech.mobile.miniapp.navigator/MiniAppExternalUrlLoader.Companion/loaderWithUrl/#kotlin.String#android.app.Activity?/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-external-url-loader/-companion/loader-with-url.md +$dokka.location:com.rakuten.tech.mobile.miniapp.navigator/MiniAppExternalUrlLoader.Companion/returnUrlTag/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-external-url-loader/-companion/return-url-tag.md +$dokka.location:com.rakuten.tech.mobile.miniapp.navigator/MiniAppExternalUrlLoader///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-external-url-loader/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.navigator/MiniAppExternalUrlLoader/shouldClose/#kotlin.String/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-external-url-loader/should-close.md +$dokka.location:com.rakuten.tech.mobile.miniapp.navigator/MiniAppExternalUrlLoader/shouldOverrideUrlLoading/#kotlin.String/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-external-url-loader/should-override-url-loading.md +$dokka.location:com.rakuten.tech.mobile.miniapp.navigator/MiniAppNavigator///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-navigator/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.navigator/MiniAppNavigator/openExternalUrl/#kotlin.String#com.rakuten.tech.mobile.miniapp.navigator.ExternalResultHandler/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-navigator/open-external-url.md +$dokka.location:com.rakuten.tech.mobile.miniapp.permission////PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.permission/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.permission/AccessTokenScope///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.permission/-access-token-scope/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.permission/AccessTokenScope/AccessTokenScope/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.permission/-access-token-scope/-access-token-scope.md +$dokka.location:com.rakuten.tech.mobile.miniapp.permission/AccessTokenScope/AccessTokenScope/#kotlin.String#kotlin.collections.List[kotlin.String]/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.permission/-access-token-scope/-access-token-scope.md +$dokka.location:com.rakuten.tech.mobile.miniapp.permission/AccessTokenScope/audience/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.permission/-access-token-scope/audience.md +$dokka.location:com.rakuten.tech.mobile.miniapp.permission/AccessTokenScope/scopes/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.permission/-access-token-scope/scopes.md +$dokka.location:com.rakuten.tech.mobile.miniapp.permission/MiniAppCustomPermission///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.permission/MiniAppCustomPermission/MiniAppCustomPermission/#kotlin.String#kotlin.collections.List[kotlin.Pair[com.rakuten.tech.mobile.miniapp.permission.MiniAppCustomPermissionType,com.rakuten.tech.mobile.miniapp.permission.MiniAppCustomPermissionResult]]/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission/-mini-app-custom-permission.md +$dokka.location:com.rakuten.tech.mobile.miniapp.permission/MiniAppCustomPermission/miniAppId/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission/mini-app-id.md +$dokka.location:com.rakuten.tech.mobile.miniapp.permission/MiniAppCustomPermission/pairValues/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission/pair-values.md +$dokka.location:com.rakuten.tech.mobile.miniapp.permission/MiniAppCustomPermissionResponse.CustomPermissionResponseObj///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-response/-custom-permission-response-obj/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.permission/MiniAppCustomPermissionResponse.CustomPermissionResponseObj/CustomPermissionResponseObj/#kotlin.String#kotlin.String/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-response/-custom-permission-response-obj/-custom-permission-response-obj.md +$dokka.location:com.rakuten.tech.mobile.miniapp.permission/MiniAppCustomPermissionResponse.CustomPermissionResponseObj/name/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-response/-custom-permission-response-obj/name.md +$dokka.location:com.rakuten.tech.mobile.miniapp.permission/MiniAppCustomPermissionResponse.CustomPermissionResponseObj/status/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-response/-custom-permission-response-obj/status.md +$dokka.location:com.rakuten.tech.mobile.miniapp.permission/MiniAppCustomPermissionResponse///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-response/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.permission/MiniAppCustomPermissionResponse/MiniAppCustomPermissionResponse/#java.util.ArrayList[com.rakuten.tech.mobile.miniapp.permission.MiniAppCustomPermissionResponse.CustomPermissionResponseObj]/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-response/-mini-app-custom-permission-response.md +$dokka.location:com.rakuten.tech.mobile.miniapp.permission/MiniAppCustomPermissionResponse/permissions/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-response/permissions.md +$dokka.location:com.rakuten.tech.mobile.miniapp.permission/MiniAppCustomPermissionResult.ALLOWED///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-a-l-l-o-w-e-d/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.permission/MiniAppCustomPermissionResult.DENIED///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-d-e-n-i-e-d/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.permission/MiniAppCustomPermissionResult.PERMISSION_NOT_AVAILABLE///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/-p-e-r-m-i-s-s-i-o-n_-n-o-t_-a-v-a-i-l-a-b-l-e/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.permission/MiniAppCustomPermissionResult///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-result/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.permission/MiniAppCustomPermissionType.ACCESS_TOKEN///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-a-c-c-e-s-s_-t-o-k-e-n/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.permission/MiniAppCustomPermissionType.CONTACT_LIST///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-c-o-n-t-a-c-t_-l-i-s-t/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.permission/MiniAppCustomPermissionType.FILE_DOWNLOAD///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-f-i-l-e_-d-o-w-n-l-o-a-d/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.permission/MiniAppCustomPermissionType.LOCATION///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-l-o-c-a-t-i-o-n/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.permission/MiniAppCustomPermissionType.POINTS///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-p-o-i-n-t-s/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.permission/MiniAppCustomPermissionType.PROFILE_PHOTO///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-p-r-o-f-i-l-e_-p-h-o-t-o/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.permission/MiniAppCustomPermissionType.SEND_MESSAGE///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-s-e-n-d_-m-e-s-s-a-g-e/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.permission/MiniAppCustomPermissionType.UNKNOWN///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-u-n-k-n-o-w-n/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.permission/MiniAppCustomPermissionType.USER_NAME///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/-u-s-e-r_-n-a-m-e/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.permission/MiniAppCustomPermissionType///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.permission/MiniAppCustomPermissionType/type/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-custom-permission-type/type.md +$dokka.location:com.rakuten.tech.mobile.miniapp.permission/MiniAppDevicePermissionType.CAMERA///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-device-permission-type/-c-a-m-e-r-a/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.permission/MiniAppDevicePermissionType.LOCATION///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-device-permission-type/-l-o-c-a-t-i-o-n/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.permission/MiniAppDevicePermissionType.UNKNOWN///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-device-permission-type/-u-n-k-n-o-w-n/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.permission/MiniAppDevicePermissionType///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-device-permission-type/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.permission/MiniAppDevicePermissionType/type/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.permission/-mini-app-device-permission-type/type.md +$dokka.location:com.rakuten.tech.mobile.miniapp.signatureverifier.api////PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.signatureverifier.api/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.signatureverifier.api/InvalidSignatureVerifierBaseUrlException///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-base-url-exception/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.signatureverifier.api/InvalidSignatureVerifierBaseUrlException/InvalidSignatureVerifierBaseUrlException/#java.lang.IllegalArgumentException/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-base-url-exception/-invalid-signature-verifier-base-url-exception.md +$dokka.location:com.rakuten.tech.mobile.miniapp.signatureverifier.api/InvalidSignatureVerifierSubscriptionException///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.signatureverifier.api/InvalidSignatureVerifierSubscriptionException/InvalidSignatureVerifierSubscriptionException/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.signatureverifier.api/-invalid-signature-verifier-subscription-exception/-invalid-signature-verifier-subscription-exception.md +$dokka.location:com.rakuten.tech.mobile.miniapp.view////PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.view/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.view/MiniAppConfig///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-config/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.view/MiniAppConfig/MiniAppConfig/#com.rakuten.tech.mobile.miniapp.MiniAppSdkConfig#com.rakuten.tech.mobile.miniapp.js.MiniAppMessageBridge#com.rakuten.tech.mobile.miniapp.navigator.MiniAppNavigator?#com.rakuten.tech.mobile.miniapp.file.MiniAppFileChooser?#kotlin.String/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-config/-mini-app-config.md +$dokka.location:com.rakuten.tech.mobile.miniapp.view/MiniAppConfig/miniAppFileChooser/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-config/mini-app-file-chooser.md +$dokka.location:com.rakuten.tech.mobile.miniapp.view/MiniAppConfig/miniAppMessageBridge/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-config/mini-app-message-bridge.md +$dokka.location:com.rakuten.tech.mobile.miniapp.view/MiniAppConfig/miniAppNavigator/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-config/mini-app-navigator.md +$dokka.location:com.rakuten.tech.mobile.miniapp.view/MiniAppConfig/miniAppSdkConfig/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-config/mini-app-sdk-config.md +$dokka.location:com.rakuten.tech.mobile.miniapp.view/MiniAppConfig/queryParams/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-config/query-params.md +$dokka.location:com.rakuten.tech.mobile.miniapp.view/MiniAppParameters.DefaultParams///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-default-params/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.view/MiniAppParameters.DefaultParams/DefaultParams/#android.content.Context#com.rakuten.tech.mobile.miniapp.view.MiniAppConfig#kotlin.String#kotlin.String#kotlin.Boolean/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-default-params/-default-params.md +$dokka.location:com.rakuten.tech.mobile.miniapp.view/MiniAppParameters.DefaultParams/config/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-default-params/config.md +$dokka.location:com.rakuten.tech.mobile.miniapp.view/MiniAppParameters.DefaultParams/context/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-default-params/context.md +$dokka.location:com.rakuten.tech.mobile.miniapp.view/MiniAppParameters.DefaultParams/fromCache/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-default-params/from-cache.md +$dokka.location:com.rakuten.tech.mobile.miniapp.view/MiniAppParameters.DefaultParams/miniAppId/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-default-params/mini-app-id.md +$dokka.location:com.rakuten.tech.mobile.miniapp.view/MiniAppParameters.DefaultParams/miniAppVersion/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-default-params/mini-app-version.md +$dokka.location:com.rakuten.tech.mobile.miniapp.view/MiniAppParameters.InfoParams///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-info-params/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.view/MiniAppParameters.InfoParams/InfoParams/#android.content.Context#com.rakuten.tech.mobile.miniapp.view.MiniAppConfig#com.rakuten.tech.mobile.miniapp.MiniAppInfo#kotlin.Boolean/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-info-params/-info-params.md +$dokka.location:com.rakuten.tech.mobile.miniapp.view/MiniAppParameters.InfoParams/config/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-info-params/config.md +$dokka.location:com.rakuten.tech.mobile.miniapp.view/MiniAppParameters.InfoParams/context/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-info-params/context.md +$dokka.location:com.rakuten.tech.mobile.miniapp.view/MiniAppParameters.InfoParams/fromCache/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-info-params/from-cache.md +$dokka.location:com.rakuten.tech.mobile.miniapp.view/MiniAppParameters.InfoParams/miniAppInfo/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-info-params/mini-app-info.md +$dokka.location:com.rakuten.tech.mobile.miniapp.view/MiniAppParameters.UrlParams///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-url-params/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.view/MiniAppParameters.UrlParams/UrlParams/#android.content.Context#com.rakuten.tech.mobile.miniapp.view.MiniAppConfig#kotlin.String/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-url-params/-url-params.md +$dokka.location:com.rakuten.tech.mobile.miniapp.view/MiniAppParameters.UrlParams/config/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-url-params/config.md +$dokka.location:com.rakuten.tech.mobile.miniapp.view/MiniAppParameters.UrlParams/context/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-url-params/context.md +$dokka.location:com.rakuten.tech.mobile.miniapp.view/MiniAppParameters.UrlParams/miniAppUrl/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/-url-params/mini-app-url.md +$dokka.location:com.rakuten.tech.mobile.miniapp.view/MiniAppParameters///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-parameters/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.view/MiniAppView.Companion///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-view/-companion/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.view/MiniAppView.Companion/init/#com.rakuten.tech.mobile.miniapp.view.MiniAppParameters/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-view/-companion/init.md +$dokka.location:com.rakuten.tech.mobile.miniapp.view/MiniAppView///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-view/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp.view/MiniAppView/load/#kotlin.String#kotlin.Boolean#kotlin.Function2[com.rakuten.tech.mobile.miniapp.MiniAppDisplay?,com.rakuten.tech.mobile.miniapp.MiniAppSdkException?,kotlin.Unit]/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-view/load.md +$dokka.location:com.rakuten.tech.mobile.miniapp.view/MiniAppView/loadFromBundle/#com.rakuten.tech.mobile.miniapp.MiniAppManifest?#kotlin.Function2[com.rakuten.tech.mobile.miniapp.MiniAppDisplay?,com.rakuten.tech.mobile.miniapp.MiniAppSdkException?,kotlin.Unit]/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-view/load-from-bundle.md +$dokka.location:com.rakuten.tech.mobile.miniapp.view/MiniAppView/sendJsonToMiniApp/#kotlin.String#kotlin.Function0[kotlin.Unit]/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp.view/-mini-app-view/send-json-to-mini-app.md +$dokka.location:com.rakuten.tech.mobile.miniapp////PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp/Host///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-host/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp/Host/Host/#kotlin.String#kotlin.String/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-host/-host.md +$dokka.location:com.rakuten.tech.mobile.miniapp/Host/id/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-host/id.md +$dokka.location:com.rakuten.tech.mobile.miniapp/Host/subscriptionKey/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-host/subscription-key.md +$dokka.location:com.rakuten.tech.mobile.miniapp/InvalidMiniAppInfoException///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-invalid-mini-app-info-exception/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp/InvalidMiniAppInfoException/InvalidMiniAppInfoException/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-invalid-mini-app-info-exception/-invalid-mini-app-info-exception.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniApp.Companion///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/-companion/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniApp.Companion/instance/#com.rakuten.tech.mobile.miniapp.MiniAppSdkConfig#kotlin.Boolean/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/-companion/instance.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniApp///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniApp/clearSecureStorage/#android.content.Context#kotlin.String/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/clear-secure-storage.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniApp/clearSecureStorages/#android.content.Context/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/clear-secure-storages.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniApp/create/#com.rakuten.tech.mobile.miniapp.MiniAppInfo#com.rakuten.tech.mobile.miniapp.js.MiniAppMessageBridge#com.rakuten.tech.mobile.miniapp.navigator.MiniAppNavigator?#com.rakuten.tech.mobile.miniapp.file.MiniAppFileChooser?#kotlin.String#kotlin.Boolean/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/create.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniApp/create/#kotlin.String#com.rakuten.tech.mobile.miniapp.js.MiniAppMessageBridge#com.rakuten.tech.mobile.miniapp.navigator.MiniAppNavigator?#com.rakuten.tech.mobile.miniapp.file.MiniAppFileChooser?#kotlin.String#kotlin.Boolean/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/create.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniApp/createWithUrl/#kotlin.String#com.rakuten.tech.mobile.miniapp.js.MiniAppMessageBridge#com.rakuten.tech.mobile.miniapp.navigator.MiniAppNavigator?#com.rakuten.tech.mobile.miniapp.file.MiniAppFileChooser?#kotlin.String/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/create-with-url.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniApp/downloadMiniApp/#kotlin.String#kotlin.String#kotlin.Function2[kotlin.Boolean,com.rakuten.tech.mobile.miniapp.MiniAppSdkException?,kotlin.Unit]/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/download-mini-app.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniApp/fetchInfo/#kotlin.String/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/fetch-info.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniApp/getCustomPermissions/#kotlin.String/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/get-custom-permissions.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniApp/getDownloadedManifest/#kotlin.String/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/get-downloaded-manifest.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniApp/getMiniAppInfoByPreviewCode/#kotlin.String/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/get-mini-app-info-by-preview-code.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniApp/getMiniAppManifest/#kotlin.String#kotlin.String#kotlin.String/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/get-mini-app-manifest.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniApp/isMiniAppCacheAvailable/#kotlin.String#kotlin.String/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/is-mini-app-cache-available.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniApp/listDownloadedWithCustomPermissions/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/list-downloaded-with-custom-permissions.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniApp/listMiniApp/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/list-mini-app.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniApp/setCustomPermissions/#com.rakuten.tech.mobile.miniapp.permission.MiniAppCustomPermission/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/set-custom-permissions.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniApp/unzipBundle/#kotlin.String#kotlin.String#kotlin.String#kotlin.Function2[kotlin.Boolean,com.rakuten.tech.mobile.miniapp.MiniAppSdkException?,kotlin.Unit]?/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app/unzip-bundle.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppBundleNotFoundException///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-bundle-not-found-exception/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppBundleNotFoundException/MiniAppBundleNotFoundException/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-bundle-not-found-exception/-mini-app-bundle-not-found-exception.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppDisplay///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-display/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppDisplay/destroyView/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-display/destroy-view.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppDisplay/getMiniAppView/#android.content.Context/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-display/get-mini-app-view.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppDisplay/navigateBackward/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-display/navigate-backward.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppDisplay/navigateForward/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-display/navigate-forward.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppDisplay/sendJsonToMiniApp/#kotlin.String/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-display/send-json-to-mini-app.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppHasCorruptedException///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-has-corrupted-exception/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppHasCorruptedException/MiniAppHasCorruptedException/#kotlin.String/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-has-corrupted-exception/-mini-app-has-corrupted-exception.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppHasNoPublishedVersionException///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-has-no-published-version-exception/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppHasNoPublishedVersionException/MiniAppHasNoPublishedVersionException/#kotlin.String/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-has-no-published-version-exception/-mini-app-has-no-published-version-exception.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppHostException///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-host-exception/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppHostException/MiniAppHostException/#kotlin.String/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-host-exception/-mini-app-host-exception.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppInfo.Companion///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/-companion/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppInfo///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppInfo/MiniAppInfo/#kotlin.String#kotlin.String#kotlin.String#com.rakuten.tech.mobile.miniapp.Version#kotlin.String?#kotlin.String?/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/-mini-app-info.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppInfo/displayName/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/display-name.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppInfo/icon/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/icon.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppInfo/id/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/id.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppInfo/promotionalImageUrl/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/promotional-image-url.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppInfo/promotionalText/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/promotional-text.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppInfo/version/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-info/version.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppManifest///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-manifest/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppManifest/MiniAppManifest/#kotlin.collections.List[kotlin.Pair[com.rakuten.tech.mobile.miniapp.permission.MiniAppCustomPermissionType,kotlin.String]]#kotlin.collections.List[kotlin.Pair[com.rakuten.tech.mobile.miniapp.permission.MiniAppCustomPermissionType,kotlin.String]]#kotlin.collections.List[com.rakuten.tech.mobile.miniapp.permission.AccessTokenScope]#kotlin.collections.Map[kotlin.String,kotlin.String]#kotlin.String/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-manifest/-mini-app-manifest.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppManifest/accessTokenPermissions/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-manifest/access-token-permissions.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppManifest/customMetaData/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-manifest/custom-meta-data.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppManifest/optionalPermissions/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-manifest/optional-permissions.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppManifest/requiredPermissions/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-manifest/required-permissions.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppManifest/versionId/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-manifest/version-id.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppNetException///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-net-exception/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppNetException/MiniAppNetException/#java.lang.Exception/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-net-exception/-mini-app-net-exception.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppNetException/MiniAppNetException/#kotlin.String#kotlin.Throwable?/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-net-exception/-mini-app-net-exception.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppNetException/MiniAppNetException/#kotlin.String/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-net-exception/-mini-app-net-exception.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppNotFoundException///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-not-found-exception/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppNotFoundException/MiniAppNotFoundException/#kotlin.String/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-not-found-exception/-mini-app-not-found-exception.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppSdkConfig///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppSdkConfig/MiniAppSdkConfig/#kotlin.String#kotlin.String#kotlin.String#kotlin.String#kotlin.String#kotlin.Boolean#kotlin.Boolean#kotlin.collections.List[com.rakuten.tech.mobile.miniapp.analytics.MiniAppAnalyticsConfig]#kotlin.collections.List[kotlin.String]#kotlin.Boolean#kotlin.String/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/-mini-app-sdk-config.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppSdkConfig/baseUrl/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/base-url.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppSdkConfig/enableH5Ads/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/enable-h5-ads.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppSdkConfig/hostAppUserAgentInfo/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/host-app-user-agent-info.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppSdkConfig/hostAppVersionId/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/host-app-version-id.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppSdkConfig/isPreviewMode/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/is-preview-mode.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppSdkConfig/maxStorageSizeLimitInBytes/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/max-storage-size-limit-in-bytes.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppSdkConfig/miniAppAnalyticsConfigList/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/mini-app-analytics-config-list.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppSdkConfig/rasProjectId/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/ras-project-id.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppSdkConfig/requireSignatureVerification/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/require-signature-verification.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppSdkConfig/sslPinningPublicKeyList/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/ssl-pinning-public-key-list.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppSdkConfig/subscriptionKey/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-config/subscription-key.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppSdkException///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-exception/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppSdkException/MiniAppSdkException/#java.lang.Exception/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-exception/-mini-app-sdk-exception.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppSdkException/MiniAppSdkException/#kotlin.String#kotlin.Throwable?/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-exception/-mini-app-sdk-exception.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppSdkException/MiniAppSdkException/#kotlin.String/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-sdk-exception/-mini-app-sdk-exception.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppTooManyRequestsError///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-too-many-requests-error/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppTooManyRequestsError/MiniAppTooManyRequestsError/#kotlin.String?/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-too-many-requests-error/-mini-app-too-many-requests-error.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppVerificationException///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-verification-exception/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp/MiniAppVerificationException/MiniAppVerificationException/#kotlin.String?/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-mini-app-verification-exception/-mini-app-verification-exception.md +$dokka.location:com.rakuten.tech.mobile.miniapp/PreviewMiniAppInfo///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-preview-mini-app-info/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp/PreviewMiniAppInfo/PreviewMiniAppInfo/#com.rakuten.tech.mobile.miniapp.Host#com.rakuten.tech.mobile.miniapp.MiniAppInfo/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-preview-mini-app-info/-preview-mini-app-info.md +$dokka.location:com.rakuten.tech.mobile.miniapp/PreviewMiniAppInfo/host/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-preview-mini-app-info/host.md +$dokka.location:com.rakuten.tech.mobile.miniapp/PreviewMiniAppInfo/miniapp/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-preview-mini-app-info/miniapp.md +$dokka.location:com.rakuten.tech.mobile.miniapp/RequiredPermissionsNotGrantedException///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-required-permissions-not-granted-exception/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp/RequiredPermissionsNotGrantedException/RequiredPermissionsNotGrantedException/#kotlin.String#kotlin.String/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-required-permissions-not-granted-exception/-required-permissions-not-granted-exception.md +$dokka.location:com.rakuten.tech.mobile.miniapp/SSLCertificatePinningException///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-s-s-l-certificate-pinning-exception/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp/SSLCertificatePinningException/SSLCertificatePinningException/#kotlin.String/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-s-s-l-certificate-pinning-exception/-s-s-l-certificate-pinning-exception.md +$dokka.location:com.rakuten.tech.mobile.miniapp/Version///PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-version/index.md +$dokka.location:com.rakuten.tech.mobile.miniapp/Version/Version/#kotlin.String#kotlin.String/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-version/-version.md +$dokka.location:com.rakuten.tech.mobile.miniapp/Version/versionId/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-version/version-id.md +$dokka.location:com.rakuten.tech.mobile.miniapp/Version/versionTag/#/PointingToDeclaration/miniapp/com.rakuten.tech.mobile.miniapp/-version/version-tag.md +com.rakuten.tech.mobile.miniapp +com.rakuten.tech.mobile.miniapp.analytics +com.rakuten.tech.mobile.miniapp.closealert +com.rakuten.tech.mobile.miniapp.display +com.rakuten.tech.mobile.miniapp.errors +com.rakuten.tech.mobile.miniapp.file +com.rakuten.tech.mobile.miniapp.js +com.rakuten.tech.mobile.miniapp.js.chat +com.rakuten.tech.mobile.miniapp.js.hostenvironment +com.rakuten.tech.mobile.miniapp.js.universalbridge +com.rakuten.tech.mobile.miniapp.js.userinfo +com.rakuten.tech.mobile.miniapp.navigator +com.rakuten.tech.mobile.miniapp.permission +com.rakuten.tech.mobile.miniapp.signatureverifier.api +com.rakuten.tech.mobile.miniapp.view + diff --git a/docs/5.6/index.md b/docs/5.6/index.md new file mode 100644 index 000000000..c1de74eb0 --- /dev/null +++ b/docs/5.6/index.md @@ -0,0 +1,1399 @@ +--- +layout: userguide +--- + +# Mini App SDK for Android + +Provides functionality to show a Mini App in Android Applications. The SDK offers features like downloading, caching, updating, and displaying of a Mini App. +Mini App SDK also facilitates communication between a mini app and the host app via a message bridge. + +## Table of Contents +{:.no_toc} + +* Table of contents +{:toc} + +## Requirements + +- **Minimum Android Version**: This SDK supports Android 9.0+ (API level 28+). + - Note: Currently this SDK is set to `minSdkVersion 24`, however support for versions 24 to 27 is deprecated and could be removed in a later release. +- **Base URL, App ID, Subscription Key**: We don't currently provide a public API for use with this SDK. You must provide a URL for your API as well as an App ID and Subscription Key for the API. + +## Getting Started + +This section will guide you through setting up the Mini App SDK in your App and you will learn how to display your first mini app. + +### #1 Add dependency to your App + +Add the following to your `build.gradle` file: + +```groovy +repositories { + mavenCentral() +} + +dependency { + implementation 'io.github.rakutentech.miniapp:miniapp:${version}' +} +``` + +### #2 Configure SDK settings in AndroidManifest.xml + +The SDK is configured via `meta-data` tags in your `AndroidManifest.xml`. The following table lists the configurable values. + +| Field | Datatype| Manifest Key | Optional | Default | +|------------------------------|---------|--------------------------------------------------------|----------- |--------- | +| Base URL | String | `com.rakuten.tech.mobile.miniapp.BaseUrl` | ❌ | 🚫 | +| Is Preview Mode | Boolean | `com.rakuten.tech.mobile.miniapp.IsPreviewMode` | βœ… | false | +| Require Signature Verification | Boolean | `com.rakuten.tech.mobile.miniapp.RequireSignatureVerification` | βœ… | false | +| RAS Project ID | String | `com.rakuten.tech.mobile.ras.ProjectId` | ❌ | 🚫 | +| RAS Project Subscription Key | String | `com.rakuten.tech.mobile.ras.ProjectSubscriptionKey` | ❌ | 🚫 | +| Host App User Agent Info | String | `com.rakuten.tech.mobile.miniapp.HostAppUserAgentInfo` | βœ… | 🚫 | +| Enable [Ad Placement api](https://developers.google.com/ad-placement) | Boolean | `com.rakuten.tech.mobile.miniapp.EnableH5Ads` | βœ… | false | +| Secure Storage Max Size | String | `com.rakuten.tech.mobile.miniapp.MaxStorageSizeLimitInBytes` | βœ… | βœ… | + +**Note:** +* We don't currently host a public API, so you will need to provide your own Base URL for API requests. +* The "Host App User Agent Info" is the string which is appended to user-agent of webview. It should be a meaningful keyword such as host app name to differentiate other host apps. + +
Click to expand example AndroidManifest.xml + + +```xml + + + + + + + + + + + + + + + + + + + + + + + +``` +
+ +### #3 Create and display a Mini App +**API Docs:** [MiniApp.create](api/com.rakuten.tech.mobile.miniapp/-mini-app/create.html), [MiniAppDisplay](api/com.rakuten.tech.mobile.miniapp/-mini-app-display/), [MiniAppMessageBridge](api/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge) + +`MiniApp.create` is used to create a `View` for displaying a specific mini app. Before calling `MiniApp.create`, the Host App should first get the manifest using `MiniApp.getMiniAppManifest`, show permission prompt to user, then set the result with `MiniApp.setCustomPermissions`. +If Host App wants to launch/download the miniapp without granting the required permissions, the SDK will throw `RequiredPermissionsNotGrantedException` to notify Host App. +You must provide the mini app ID which you wish to create (you can get the mini app ID by [Fetching Mini App Info](#fetching-mini-app-info) first). Calling `MiniApp.create` will do the following: + +- Check what is the latest, published version of the mini app. +- Check if the latest version of the mini app has been downloaded. + - If yes, return the already downloaded mini app. + - If no, download the latest version and then return the downloaded version. +- If the device is disconnected from the internet and the device already has a version of the mini app downloaded, then the already downloaded version will be returned. +- If the host app needs the cached version of the miniapp, set `fromCache` value to `true` will return already downloaded version. + +After calling `MiniApp.create` and all the "required" manifest permissions have been granted, you will obtain an instance of `MiniAppDisplay` which represents the downloaded mini app. You can call `MiniAppDisplay.getMiniAppView` to obtain a `View` for displaying the mini app. + +The following is a simplified example: + +```kotlin +try { + val miniAppMessageBridge = object : MiniAppMessageBridge() { + // implement methods for mini app bridge + } + + val miniAppDisplay = withContext(Dispatchers.IO) { + MiniApp.instance().create("MINI_APP_ID", miniAppMessageBridge) + } + val miniAppView = miniAppDisplay.getMiniAppView(this@YourActivity) + + // Add the view to your Activity +} catch (e: MiniAppSdkException) { + // Handle exception +} +``` + +Note that this is a simplified example. See [Mini App Features](#mini-app-features) for the full functionality which you can provide to the mini app. The following is a more complete example: + +
Click here to expand a full code example + + +```kotlin +class MiniAppActivity : Activity(), CoroutineScope { + + override val coroutineContext = Dispatchers.Main + + private var miniAppDisplay: MiniAppDisplay + + override fun onCreate(savedInstanceState: Bundle?) { + super(savedInstanceState) + setContentView(R.layout.loading) + + launch { + try { + miniAppDisplay = withContext(Dispatchers.IO) { + MiniApp.instance().create("MINI_APP_ID", createMessageBridge()) + } + val miniAppView = miniAppDisplay.getMiniAppView(this@MiniAppActivity) + + setContentView(miniAppView) + } catch (e: MiniAppSdkException) { + setContentView(R.layout.error_screen) + } + } + } + + override fun onDestroy() { + super.onDestroy() + miniAppDisplay.destroyView() + } + + fun createMessageBridge() = object : MiniAppMessageBridge() { + override fun getUniqueId( + onSuccess: (uniqueId: String) -> Unit, + onError: (message: String) -> Unit + ) { + if (...) + onSuccess("your-unique-id") + else + onError("your-error-message") + } + + override fun requestPermission( + miniAppPermissionType: MiniAppPermissionType, + callback: (isGranted: Boolean) -> Unit + ) { + // Implementation details to request device permissions + + callback.invoke(true) + } + + // You can additionally implement other MiniAppMessageBridge methods + } +} +``` +
+ +### #4 Create and display multiple Mini App views +**API Docs:** [MiniAppView.init](api/com.rakuten.tech.mobile.miniapp.view/-mini-app-view/init.html), [MiniAppConfig](api/com.rakuten.tech.mobile.miniapp.view/-mini-app-config.html) +`MiniAppView.init` is used to initialize the mini app view for displaying a specific mini app using `MiniAppDisplay` when `MiniAppView.load` is being called. `MiniAppParameters` needed to send with the `MiniAppView.init` call. + +Before calling `MiniAppView.init`, the Host App should first get the manifest using `MiniApp.getMiniAppManifest`, show permission prompt to user, then set the result with `MiniApp.setCustomPermissions`. +If Host App wants to launch the miniapp without granting the required permissions, the SDK will throw `RequiredPermissionsNotGrantedException` to notify Host App. +You must provide `MiniAppConfig` and `Context` while initializing `MiniAppView`. You must provide the mini app ID which you wish to create (you can get the mini app ID by [Fetching Mini App Info](#fetching-mini-app-info) first). +Calling `MiniAppView.load` will do the following: +- Check what is the latest, published version of the mini app. +- Check if the latest version of the mini app has been downloaded. + - If yes, return the already downloaded mini app. + - If no, download the latest version and then return the downloaded version. +- If the device is disconnected from the internet and the device already has a version of the mini app downloaded, then the already downloaded version will be returned. +- If the host app needs the cached version of the miniapp, set `fromCache` value to `true` will return already downloaded version. + +After calling `MiniAppView.load` and all the "required" manifest permissions have been granted, you will obtain an instance of `MiniAppDisplay` which represents the downloaded mini app. You can call `MiniAppDisplay.getMiniAppView` to obtain a `View` for displaying the mini app. You will get an instance of `MiniAppSdkException` you any exception happens. + +The following is a simplified example: +```kotlin +val param = MiniAppParameters.DefaultParams( + context = this, + config = MiniAppConfig( + miniAppSdkConfig = miniAppSdkConfig, + miniAppMessageBridge = miniAppMessageBridge, + miniAppNavigator = miniAppNavigator, + miniAppFileChooser = miniAppFileChooser, + queryParams = "" + ), + miniAppId = "id", + miniAppVersion = "version", + fromCache = false + ) + +val miniapp = MiniAppView.init(param) +``` +To load the miniapp following load function needed to call +```kotlin +miniapp.load { miniAppDisplay, miniAppSdkException -> + if(miniAppDisplay != null) { + val miniAppView = miniAppDisplay.getMiniAppView(this@MiniAppActivity) + // view could be added to show the miniapp + runOnUithread { + rootView.addView(miniAppView) + } + } +} +``` +To load the miniapp from Bundle following load function needed to call +```kotlin +miniapp.loadFromBundle { miniAppDisplay, miniAppSdkException -> + if(miniAppDisplay != null) { + val miniAppView = miniAppDisplay.getMiniAppView(this@MiniAppActivity) + // view could be added to show the miniapp + runOnUithread { + rootView.addView(miniAppView) + } + } +} +``` + +**Note:** +* **Clean-up:** +Clearing up the mini app display is essential. `MiniAppDisplay.destroyView` is required to be called when exit miniapp. +* **Suspend functions:** +This SDK uses `suspend` functions, so you should use [Kotlin Coroutines](https://kotlinlang.org/docs/reference/coroutines-overview.html) when calling the functions. These examples use `Dispatchers.IO`, but you can use whichever `CoroutineContext` and `CouroutineScope` that is appropriate for your App. However, you MUST NOT use `Dispatchers.Main` because network requests cannot be performed on the main thread. +* **Preview Mode:** +In preview mode, you can have multiple versions of single miniapp so you can load the specific version with MiniAppInfo object by using `MiniApp.instance().create(MINI_APP_INFO, miniAppMessageBridge)`. +* **Exceptions:** +There are several different types of exceptions which could be thrown by `MiniApp.create`, but all are sub-classes of `MiniAppSdkException`. +You can handle each exception type differently if you would like different behavior for different cases. +For example you may wish to display a different error message when the server contains no published versions of a mini app. +See the full list of exceptions in the [API docs](api/com.rakuten.tech.mobile.miniapp/-mini-app/create.html). +* **Universal Bridge:** +Sending data from host app to miniapp. `MiniAppDisplay.sendJsonToHostApp` is required to be called when host app wants to send data to miniapp. + +## Mini App Features +**API Docs:** [MiniAppMessageBridge](api/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge) + +The `MiniAppMessageBridge` is used for passing messages between the Mini App (JavaScript) and the Host App (your native Android App) and vice versa. Your App must provide the implementation for these functions and pass this implementation to the `MiniApp.create` function. + +There are some methods have a default implementation but the host app can override them to fully control. + +| Method | Default | +|------------------------------|----------| +| getUniqueId | 🚫 | +| requestPermission | 🚫 | +| requestDevicePermission | 🚫 | +| requestCustomPermissions | βœ… | +| shareContent | βœ… | +| getHostEnvironmentInfo | βœ… | +| sendJsonToHostApp | 🚫 | +| getHostAppThemeColors | 🚫 | +| getIsDarkMode | 🚫 | +| didReceiveMAAnalytics | 🚫 | + + +The `UserInfoBridgeDispatcher`: + +| Method | Default | +|------------------------------|----------| +| getUserName | 🚫 | +| getProfilePhoto | 🚫 | +| getAccessToken | 🚫 | +| getContacts | 🚫 | +| getPoints | 🚫 | + +The `ChatBridgeDispatcher`: + +| Method | Default | +|------------------------------|----------| +| sendMessageToContact | 🚫 | +| sendMessageToContactId | 🚫 | +| sendMessageToMultipleContacts| 🚫 | + +The sections below explain each feature in more detail. + +The following is a full code example of using `MiniAppMessageBridge`. + +
Click here to expand full code example of MiniAppMessageBridge + + +```kotlin +val miniAppMessageBridge = object: MiniAppMessageBridge() { + override fun getUniqueId() { + var id: String = "" + // Implementation details to generate a Unique ID + // .. .. .. + + return id + } + + override fun requestDevicePermission( + miniAppPermissionType: MiniAppDevicePermissionType, + callback: (isGranted: Boolean) -> Unit + ) { + // Implementation details to request device permission for location + // .. .. .. + + callback.invoke(true) + } + + // Implement requestCustomPermissions if HostApp wants to show their own UI for managing permissions + override fun requestCustomPermissions( + permissionsWithDescription: List>, + callback: (List>) -> Unit + ) { + // Implementation details to request custom permissions + // .. .. .. + // pass a list of Pair of MiniAppCustomPermissionType and MiniAppCustomPermissionResult in callback + callback.invoke(list) + } + + override fun shareContent( + content: String, + callback: (isSuccess: Boolean, message: String?) -> Unit + ) { + // Share content implementation. + // .. .. .. + + callback.invoke(true, null) // or callback.invoke(false, "error message") + } + + override fun getHostEnvironmentInfo( + onSuccess: (info: HostEnvironmentInfo) -> Unit, + onError: (infoError: HostEnvironmentInfoError) -> Unit + ) { + // Check if there is any environment info in HostApp + if (hasInfo) { + // allow miniapp to invoke the host environment info + onSuccess(hostEnvironmentInfo) + } + else + onError(hostEnvironmentError) // reject miniapp to send host environment info with message explanation. + } + + override fun sendJsonToHostApp( + jsonStr: String, + onSuccess: (String) -> Unit, + onError: (message: String) -> Unit + ) { + //validation preference for incoming json message + if(jsonStr.isNotBlank()){ + onSuccess(jsonStr) + } else { + onError(jsonStr) + } + } + + override fun getHostAppThemeColors( + onSuccess: (themeColor: HostAppThemeColors) -> Unit, + onError: (message: String) -> Unit + ) { + onSuccess(HostAppThemeColors(primaryColor = "", secondaryColor = "")) + } + + override fun getIsDarkMode( + onSuccess: (isDarkMode: Boolean) -> Unit, + onError: (message: String) -> Unit + ) { + when (activity.resources.configuration.uiMode and Configuration.UI_MODE_NIGHT_MASK) { + Configuration.UI_MODE_NIGHT_NO -> onSuccess(false) // Night mode is not active, we're using the light theme. + Configuration.UI_MODE_NIGHT_YES -> onSuccess(true) // Night mode is active, we're using dark theme. + } + } + +} + +val userInfoBridgeDispatcher = object : UserInfoBridgeDispatcher { + + override fun getUserName( + onSuccess: (userName: String) -> Unit, + onError: (message: String) -> Unit + ) { + val name: String? + // Check if there is any valid username in HostApp + // .. .. .. + if (isNameValid) // Check if name is valid + onSuccess(name) // allow miniapp to get user name. + else + onError(message) // reject miniapp to get user name with message explanation. + } + + override fun getProfilePhoto( + onSuccess: (profilePhoto: String) -> Unit, + onError: (message: String) -> Unit + ) { + val photoUrl: String? + // Check if there is any valid photo url in HostApp + // .. .. .. + if (isPhotoUrlValid) // Check if photoUrl is valid + onSuccess(photoUrl) // allow miniapp to get photo url. + else + onError(message) // reject miniapp to get photo url with message explanation. + } + + override fun getAccessToken( + miniAppId: String, + accessTokenScope: AccessTokenScope, + onSuccess: (tokenData: TokenData) -> Unit, + onError: (tokenError: MiniAppAccessTokenError) -> Unit + ) { + var allowToken: Boolean = false + // Check if you want to allow this Mini App ID to use the Access Token based on AccessTokenScope. + // .. .. .. + if (allowToken) + onSuccess(tokenData) // allow miniapp to get token and return TokenData value. + else + onError(tokenError) // reject miniapp to get token with specific access token error type. + } + + override fun getContacts( + onSuccess: (contacts: ArrayList) -> Unit, + onError: (message: String) -> Unit + ) { + // Check if there is any contact id in HostApp + // .. .. .. + if (hasContact) + onSuccess(contacts) // allow miniapp to get contacts. + else + onError(message) // reject miniapp to get contacts with message explanation. + } + + override fun getPoints( + onSuccess: (points: Points) -> Unit, + onError: (pointsError: MiniAppPointsError) -> Unit + ) { + // Check if there is any point in HostApp + // .. .. .. + if (hasPoints) + onSuccess(points) // allow miniapp to get points. + else + onError(pointsError) // reject miniapp to get points with message explanation. + } +} + +// set UserInfoBridgeDispatcher object to miniAppMessageBridge +miniAppMessageBridge.setUserInfoBridgeDispatcher(userInfoBridgeDispatcher) + +val chatBridgeDispatcher = object : ChatBridgeDispatcher { + + override fun sendMessageToContact( + message: MessageToContact, + onSuccess: (contactId: String?) -> Unit, + onError: (message: String) -> Unit + ) { + // Check if there is any contact in HostApp + // .. .. .. + if (hasContact) { + // You can show a contact selection UI for picking a single contact. + // .. .. .. + // allow miniapp to invoke after message has been sent, + // user can invoke null when cancelling the operation. + onSuccess(contactId) + } + else + onError(message) // reject miniapp to send message with message explanation. + } + + override fun sendMessageToContactId( + contactId: String, + message: MessageToContact, + onSuccess: (contactId: String?) -> Unit, + onError: (message: String) -> Unit + ) { + if (there is contact id) { + // You can show a UI with the message content and the contactId. + // .. .. .. + // allow miniapp to invoke after message has been sent, + // user can invoke null when cancelling the operation. + onSuccess(contactId) + } + else + onError(message) // reject miniapp to send message with message explanation. + } + + override fun sendMessageToMultipleContacts( + message: MessageToContact, + onSuccess: (contactIds: List?) -> Unit, + onError: (message: String) -> Unit + ) { + // Check if there is any contact in HostApp + // .. .. .. + if (hasContact) { + // You can show a contact selection UI for picking a single contact. + // .. .. .. + // allow miniapp to invoke the contact ids where message has been sent, + // user can invoke null when cancelling the operation. + onSuccess(contactIds) + } + else + onError(message) // reject miniapp to send message with message explanation. + } +} + +// set ChatBridgeDispatcher object to miniAppMessageBridge +miniAppMessageBridge.setChatBridgeDispatcher(chatBridgeDispatcher) +``` +
+ +### Unique ID +**API Docs:** [MiniAppMessageBridge.getUniqueId](api/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/get-unique-id.html) + +Your App should provide an ID to the mini app which is unique to each user or device. The mini app can use this ID for storing session information for each user. + +### Device Permission Requests + +**API Docs:** [MiniAppMessageBridge.requestPermission](api/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/request-permission.html) + +The mini app is able to request some device permissions. Your App should be able to handle requests from the mini app for the following device permissions by ensuring that the Android permission dialog is displayed. Alternatively, if your App is not able to request certain device permissions, you can just deny that permission to all mini apps. + +- Location (`MiniAppPermissionType.LOCATION`) (`MiniAppPermissionType` has been deprecated) +- Location (`MiniAppDevicePermissionType.LOCATION`) + +### Custom Permission Requests +**API Docs:** [MiniAppMessageBridge.requestCustomPermissions](api/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/request-custom-permissions.html) + +Mini apps are able to make requests for custom permission types which are defined by the Mini App SDK. These permissions include things like user data. When a mini app requests a permission, your App should display a dialog to the user asking them to accept or deny the permissions. You can also choose to always deny some permissions if your App is not capable of providing that type of data. The following custom permission types are supported: + +- User name (`MiniAppCustomPermissionType.USER_NAME`) +- Profile photo (`MiniAppCustomPermissionType.PROFILE_PHOTO`) +- Contact list (`MiniAppCustomPermissionType.CONTACT_LIST`) + +**Note:** The Mini App SDK has a default UI built-in for the custom permission dialog, but you can choose to override this and use a custom UI. The Mini App SDK will handle caching the permission accept/deny state, and your `requestCustomPermission` function will only receive permissions which have not yet been granted to the mini app. + +### Share Content +**API Docs:** [MiniAppMessageBridge.shareContent](api/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/share-content.html) + +The mini app can share text content to either your App or another App. The default functionality for this will create a `text` type `Intent` which shows the Android chooser and allows the user to share the content to any App which accepts text. + +You can also choose to override the default functionality and instead share the text content to some feature within your own App. + +### Host Environment Info +**API Docs:** [MiniAppMessageBridge.getHostEnvironmentInfo](api/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/get-host-environment.html) + +The default functionality will provide information using `HostEnvironmentInfo` object to Mini App. Also, Host App can send it's environment information by implementing this function. + +### Send Json To Host App +**API Docs:** [MiniAppMessageBridge.sendJsonToHostApp](api/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/send-json-to-host-app.html) + +The MiniApp is able to send the Universal Bridge in `json` string format. + +### Get Host App Theme Colors +**API Docs:** [MiniAppMessageBridge.getHostAppThemeColors](api/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/get-host-app-theme-colors.html) + +Your App should provide a primary and secondary color to the mini app which is the theme colors of the host app . The mini app can use those colors and change it's appearence. + +### Get Host App Dark Mode Status +**API Docs:** [MiniAppMessageBridge.didReceiveMAAnalytics](api/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/did-receive-ma-analytics.html) + +Your App can receive analytics events from miniapp with this interface. + +### Get Analytics From MiniApp +**API Docs:** [MiniAppMessageBridge.getIsDarkMode](api/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/get-is-dark-mode.html) + +Your App should provide boolean value true if dark mode enabled in the device and false if it is disabled. + +### User Info +**API Docs:** [MiniAppMessageBridge.setUserInfoBridgeDispatcher](api/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/set-user-info-bridge-dispatcher.html) + +The mini app is able to request data about the current user from your App. Each of these types of data is associated with a `MiniAppCustomPermissionType` (except where noted). The mini app should have requested the permission before requesting the user data type. Note that the Mini App SDK will handle making sure that the permission has been granted, so if the permission has not been granted, then these functions will not be called within your App. + +The following user data types are supported. If your App does not support a certain type of data, you do not have to implement the function for it. + +- User name: string representing the user's name. See [UserInfoBridgeDispatcher.getUserName](api/com.rakuten.tech.mobile.miniapp.js.userinfo/-user-info-bridge-dispatcher/get-user-name.html) +- Profile photo: URL pointing to a photo. This can also be a Base64 data string. See [UserInfoBridgeDispatcher.getProfilePhoto](api/com.rakuten.tech.mobile.miniapp.js.userinfo/-user-info-bridge-dispatcher/get-profile-photo.html) +- Access Token: OAuth 1.0 token including token data and expiration date. Your App will be provided with the ID of the mini app and [AccessTokenScope]((api/com.rakuten.tech.mobile.miniapp.permission/-access-token-scope)) which is requesting the Access Token, so you should verify that this mini app is allowed to use the access token. See [UserInfoBridgeDispatcher.getAccessToken](api/com.rakuten.tech.mobile.miniapp.js.userinfo/-user-info-bridge-dispatcher/get-access-token.html) + +### Ads Integration +In case the host app wants to use the admob sdk, Add the following to your `build.gradle` file: +```groovy +dependency { + implementation project(':admob-latest') +} +``` + +**Admob Version** + +`admob-latest` module use Google Play Services Ads version 20.2.0. + +**API Docs:** [MiniAppMessageBridge.setAdMobDisplayer](api/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/set-ad-mob-displayer.html) + +It is optional to set AdMob for mini apps to show advertisement. +The below implementation will allow ads to be shown when mini apps trigger a request. + +Configure the Android Ads SDK from [here](https://developers.google.com/admob/android/quick-start). Don't forget to [initialize the Ads SDK](https://developers.google.com/admob/android/quick-start#initialize_the_mobile_ads_sdk). + +**Note:** We only support AdMob usage on Android 7.0+. Some ads from AdMob have inconsistent behavior on Android 6.0 due to the older webview implementation on those devices. + +#### AdMob +**API Docs:** [AdMobDisplayer](api/com.rakuten.tech.mobile.miniapp.ads/-ad-mob-displayer/) + +Set the `AdMobDisplayer` provided by `admob-latest`. This controller will handle the display of ad so no work is required from host app. +```kotlin +miniAppMessageBridge.setAdMobDisplayer(AdMobDisplayer(activityContext)) +``` + +### In-app Purchase Integration +In case the host app wants to use In-app Purchase, Add the following to your `build.gradle` file: +```groovy +dependency { + implementation project(':in-app-purchase') +} +``` + +**In-app Purchase Version** + +`in-app-purchase` module use billing client version 4.1.0. + +**API Docs:** [MiniAppMessageBridge.setInAppPurchaseProvider](api/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/set-in-app-purchase-provider.html) + +It is necessary to set `in-app-purchase` module for mini apps to purhcase products. +The below implementation will allow host to handle in-app purchase when mini apps trigger a request. + +#### In-App purchase +**API Docs:** [MiniAppMessageBridge.setInAppPurchaseProvider](api/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/set-in-app-purchase-provider.html) + +Set the `InAppPurchaseProviderDefault` provided by `in-app-purchase`. This controller will handle all the in-app purchase related actions. +```kotlin +miniAppMessageBridge.setInAppPurchaseProvider(InAppPurchaseProviderDefault(activityContext)) + +``` +if Host app wants to handle all the in-app purchase billing actions, It can extend the +[InAppPurchaseProvider](api/com.rakuten.tech.mobile.miniapp.iap/-in-app-purchase-provider/) class and add it's own logic. +```kotlin +val inAppPurchaseProvider = object : InAppPurchaseProvider { + + override fun getAllProducts( + androidStoreIds: List, + onSuccess: (productInfos: List) -> Unit, + onError: (errorType: MiniAppInAppPurchaseErrorType) -> Unit + ) { + //.. Fetch the Product information from the Google play console for the list of `androidStoreIds` that is passed via MiniApp SDK. + } + + override fun purchaseProductWith( + androidStoreId: String, + onSuccess: (purchaseData: PurchaseData) -> Unit, + onError: (errorType: MiniAppInAppPurchaseErrorType) -> Unit + ) { + //.. Initiate the Purchase Product flow for the given `androidStoreId`. + } + + override fun consumePurchaseWIth( + purhcaseToken: String, + onSuccess: (title: String, description: String) -> Unit, + onError: (errorType: MiniAppInAppPurchaseErrorType) -> Unit + ) { + //.. This interface is used to Acknwoledge/Consume the product which is `PURCHASED` already. + } + + override fun onEndConnection() { + //.. disconnect the billing client. + } + } + +//.. set the provider. +miniAppMessageBridge.setInAppPurchaseProvider(inAppPurchaseProvider) +``` + +### Send Native Events +**API Docs:** [miniAppMessageBridge.dispatchNativeEvent](api/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/dispatch-native-event.html) + +Mini apps are able to get events for custom event types which are defined by the Mini App SDK. These events include things like external webview close, pause, resume. + +- External webview close (`NativeEventType.EXTERNAL_WEBVIEW_CLOSE`) +- Pause (`NativeEventType.MINIAPP_ON_PAUSE`) +- Resume (`NativeEventType.MINIAPP_ON_RESUME`) +- Secure Storage Ready (`NativeEventType.MINIAPP_SECURE_STORAGE_READY`) +- Secure Storage Load Error(`NativeEventType.MINIAPP_SECURE_STORAGE_LOAD_ERROR`) +- Receive Json Info(`NativeEventType.MINIAPP_RECEIVE_JSON_INFO`) + +**Note:** Host app can send these events whenever these events occur and MiniApp will be able to get those events. + +#### Custom Ads Provider +**API Docs:** [MiniAppAdDisplayer](com.rakuten.tech.mobile.miniapp.ads/-mini-app-ad-displayer/) + +In case the host app wants to take control of the ad display, there is the interface `MiniAppAdDisplayer` to implement. +```kotlin +class CustomAdDisplayer: MiniAppAdDisplayer { + + override fun loadInterstitialAd(adUnitId: String, onLoaded: () -> Unit, onFailed: (String) -> Unit) { + // load the ad + } + + override fun showInterstitialAd(adUnitId: String, onClosed: () -> Unit, onFailed: (String) -> Unit) { + // show the ad + } + //...more ad implementations. +} + +miniAppMessageBridge.setAdMobDisplayer(CustomAdDisplayer()) +``` + +### Screen Orientation +**API Docs:** [MiniAppMessageBridge.allowScreenOrientation](api/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/) + +The default setting does not allow miniapp to change hostapp screen orientation. +Hostapp can allow miniapp to control the screen orientation for better experience by calling + +```kotlin +miniAppMessageBridge.allowScreenOrientation(true) +``` + +In case miniapp is allowed to control, please ensure that your activity handles screen orientation. +There are several ways to prevent the view from being reset. +In our Demo App, we set the config on activity `android:configChanges="orientation|screenSize"`. +See [here](https://developer.android.com/guide/topics/resources/runtime-changes#HandlingTheChange). + +### MiniApp Close +**API Docs:** [MiniAppMessageBridge.setMiniAppCloseListener](api/com.rakuten.tech.mobile.miniapp.js/-mini-app-message-bridge/set-mini-app-close-listener.html) + +The mini app is able to request host app to close itself. +```kotlin +miniAppMessageBridge.setMiniAppCloseListener { withConfirmationAlert -> + //... if miniapp wants to show a confirmation alert before closing withConfirmationAlert will be true. +} +``` + +## Fetching Mini App Info +**API Docs:** [MiniApp.listMiniApp](api/com.rakuten.tech.mobile.miniapp/-mini-app/list-mini-app.html), [MiniApp.fetchInfo](api/com.rakuten.tech.mobile.miniapp/-mini-app/fetch-info.html), [MiniAppInfo](api/com.rakuten.tech.mobile.miniapp/-mini-app-info/) + +Information about Mini Apps can be fetched in two different ways: by using `MiniApp.listMiniApp` to get a list of info for all Mini Apps, or by using `MiniApp.fetchInfo` to get info for a single Mini App. Either method will return `MiniAppInfo` objects with info about the Mini App such as name, icon URL, ID, version, etc. + +Use `MiniApp.listMiniApp` if you want a list of all Mini Apps: + +```kotlin +CoroutineScope(Dispatchers.IO).launch { + try { + val miniAppList = MiniApp.instance().listMiniApp() + } catch(e: MiniAppSdkException) { + Log.e("MiniApp", "There was an error retrieving the list", e) + } +} +``` + +Or use `MiniApp.fetchInfo` if you want info for a single Mini App and already know the Mini App's ID: + +```kotlin +CoroutineScope(Dispatchers.IO).launch { + try { + val miniAppInfo = MiniApp.instance().fetchInfo("MINI_APP_ID") + } catch(e: MiniAppSdkException) { + Log.e("MiniApp", "There was an error when retrieving the Mini App info", e) + } +} +``` + +## Fetching Mini App Meta data +**API Docs:** [MiniApp.getMiniAppManifest](api/com.rakuten.tech.mobile.miniapp/-mini-app/get-mini-app-manifest.html) + +MiniApp developers need to add the following attributes in manifest.json. Host App can require Mini Apps to set meta data here using "customMetaData", such as the first time launch screen options. + +```json +{ + "reqPermissions":[ + { + "name":"rakuten.miniapp.user.USER_NAME", + "reason":"Describe your reason here." + }, + { + "name":"rakuten.miniapp.user.PROFILE_PHOTO", + "reason":"Describe your reason here." + } + ], + "optPermissions":[ + { + "name":"rakuten.miniapp.user.CONTACT_LIST", + "reason":"Describe your reason here." + }, + { + "name":"rakuten.miniapp.device.LOCATION", + "reason":"Describe your reason here." + } + ], + "customMetaData":{ + "hostAppRandomTestKey":"metadata value" + } +} +``` + +In Host App, we can get the manifest information as following: + +```kotlin +CoroutineScope(Dispatchers.IO).launch { + try { + val miniAppManifest = MiniApp.instance().getMiniAppManifest( + appId = "MINI_APP_ID", + versionId = "VERSION_ID", + languageCode = "ja" + ) + + // Host App can set it's own metadata key in manifest.json to retrieve the value + miniAppManifest.customMetaData["hostAppRandomTestKey"] + } catch(e: MiniAppSdkException) { + Log.e("MiniApp", "There was an error when retrieving the Mini App manifest", e) + } +} +``` +By passing the `languageCode` e.g. `en`, `ja` in the above `getMiniAppManifest` method, you can get the localized description/reason for the permission from the platform API. +If there is no localized description/reason is available, it will return the default value given in the `manifest.json`. + +## Getting downloaded Mini App Meta data + +In Host App, we can get the downloaded manifest information as following: + +```kotlin + val downloadedManifest = MiniApp.instance().getDownloadedManifest("MINI_APP_ID") +``` + +## Send message to contacts +**API Docs:** [ChatBridgeDispatcher](api/com.rakuten.tech.mobile.miniapp.js.chat/-chat-bridge-dispatcher/) + +Send a message to a single contact, multiple contacts or to a specific contact id by using the following three methods can be triggered by the Mini App, and here are the recommended behaviors for each one: + +| |`ChatBridgeDispatcher.sendMessageToContact`|`ChatBridgeDispatcher.sendMessageToContactId`|`ChatBridgeDispatcher.sendMessageToMultipleContacts`| +|---|---|---|---| +|**Triggered when**|Mini App wants to send a message to a contact.|Triggered when Mini App wants to send a message to a specific contact.|Triggered when Mini App wants to send a message to multiple contacts. | +| **Contact chooser needed** | single contact | None | multiple contacts | +| **Action** | send the message to the chosen contact | send a message to the specific contact id without any prompt to the user | send the message to multiple chosen contacts | +| **On success** | invoke onSuccess with the ID of the contact where the message was sent. | invoke onSuccess with the ID of the contact where the message was sent. | invoke onSuccess with a list of IDs of the contacts where the message was sent. | +| **On cancellation** | invoke onSuccess null value. | invoke onSuccess null value. | invoke onSuccess null value. | +| **On error** | invoke onError when there was an error. | invoke onError when there was an error. | invoke onError when there was an error. | + +## Advanced Features + +### Clearing up mini app display +**API Docs:** [MiniAppDisplay.destroyView](api/com.rakuten.tech.mobile.miniapp/-mini-app-display/destroy-view.html) + +For a mini app, it is required to destroy necessary view state and any services registered with. +The automatic way can be used only if we want to end the `Activity` container along with mini app display. `MiniAppDisplay` complies to Android's `LifecycleObserver` contract. It is quite easy to setup for automatic clean up of resources. + +```kotlin +class MiniAppActivity : Activity(), CoroutineScope { + + override fun onCreate(savedInstanceState: Bundle?) { + //... + launch { + val miniAppDisplay = withContext(Dispatchers.IO) { + MiniApp.instance().create("mini_app_id", miniAppMessageBridge) + } + lifeCycle.addObserver(miniAppDisplay) + //... + } + } +} +``` + +To read more about `Lifecycle` please see [link](https://developer.android.com/topic/libraries/architecture/lifecycle#lc). + +On the other hand, when the consuming app manages resources manually or where it has more control on the lifecycle of views `MiniAppDisplay.destroyView` should be called upon e.g. when removing a view from the view system, yet within the same state of parent's lifecycle. + +### Navigating inside a mini app +**API Docs:** [MiniAppDisplay.navigateBackward](api/com.rakuten.tech.mobile.miniapp/-mini-app-display/navigate-backward.html), [MiniAppDisplay.navigateForward](api/com.rakuten.tech.mobile.miniapp/-mini-app-display/navigate-forward.html) + +`MiniAppDisplay.navigateBackward` and `MiniAppDisplay.navigateForward` facilitates the navigation inside a mini app if the history stack is available in it. A common usage pattern could be to link it up to the Android Back Key navigation. + +```kotlin +override fun onBackPressed() { + if(!miniAppDisplay.navigateBackward()) { + super.onBackPressed() + } +} +``` + +### External url loader +**API Docs:** [MiniAppNavigator](api/com.rakuten.tech.mobile.miniapp.navigator/), [MiniAppExternalUrlLoader](api/com.rakuten.tech.mobile.miniapp.navigator/-mini-app-external-url-loader/), [ExternalResultHandler](api/com.rakuten.tech.mobile.miniapp.navigator/-external-result-handler/) + +The mini app is loaded with the specific custom scheme and custom domain in mini app view. + +In default, the external link will be opened in custom tab. See [this](https://developers.google.com/web/android/custom-tabs). + +HostApp also can implement their own way by passing `MiniAppNavigator` object to `MiniApp.create(appId: String, miniAppMessageBridge: MiniAppMessageBridge, miniAppNavigator: MiniAppNavigator)`. + +- Implement `MiniAppNavigator`. + +```kotlin +miniAppNavigator = object : MiniAppNavigator { + override fun openExternalUrl(url: String, externalResultHandler: ExternalResultHandler) { + // Load external url with own webview. + } +} +``` + +- Create mini app display +Using `MiniApp.instance().create("MINI_APP_ID", miniAppMessageBridge, miniAppNavigator)`. +In preview mode, using `MiniApp.instance().create(MINI_APP_INFO, miniAppMessageBridge, miniAppNavigator)`. + +- Return URL result to mini app view. +Some mini apps are loaded their services with external url but in the end that external url will +trigger callback or webhook to redirect to mini app custom scheme, mini app custom domain. +The external webview / browser cannot recognize mini app url so it is required the return of +that url to mini app view. + +There are two approaches to return mini app url from host app webview to mini app view: + +#### Automatic check in WebView which belongs to separated Activity +If the external webview Activity is different from the Activity running mini app, our SDK provide +the auto check and Activity closing by overriding the [WebViewClient](https://developer.android.com/reference/android/webkit/WebViewClient). + +```kotlin +val miniAppExternalUrlLoader = MiniAppExternalUrlLoader(miniAppId, externalWebViewActivity) +``` +```kotlin +class MyWebViewClient(private val miniAppExternalUrlLoader: MiniAppExternalUrlLoader): WebViewClient() { + + override fun shouldOverrideUrlLoading(view: WebView, request: WebResourceRequest): Boolean { + val url = request.url.toString() + return miniAppExternalUrlLoader.shouldOverrideUrlLoading(url) + } +} +``` + +Return the url result to mini app view: + +```kotlin +// externalResultHandler is from MiniAppNavigator implementation. +override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) { + super.onActivityResult(requestCode, resultCode, data) + if (requestCode == externalWebViewReqCode && resultCode == Activity.RESULT_OK) { + data?.let { intent -> externalResultHandler.emitResult(intent) } + } +} +``` + +#### Manual check by host app +Host app can take full control and transmit the url back to mini app view. + +```kotlin +val miniAppExternalUrlLoader = MiniAppExternalUrlLoader(miniAppId, null) +``` +Using `miniAppExternalUrlLoader.shouldClose(url)` which returns `Boolean` to check if it is +mini app scheme and should close external webview. + +Using `#ExternalResultHandler.emitResult(String)` to transmit the url string to mini app view. + +#### Downloading files in a Mini App + +You can also optionally use your `MiniAppNavigator` to intercept file download requests from the Mini App. Note that this will only receive files that the Mini App downloaded with XHR, so the URL you receive will be a Base64 data URI. If you do not override the file download functionality, then the SDK will use default functionality to create an Intent for sharing the file to another App. + +To use this, you must implement the `MiniAppDownloadNavigator` interface in your `MiniAppNavigator` implementation. + +```kotlin +miniAppNavigator = object : MiniAppNavigator, MiniAppDownloadNavigator { + // Override MiniAppNavigator functions here + // ... + + // Override MiniAppDownloadNavigator functions + fun onFileDownloadStart(url: String, userAgent: String, contentDisposition: String, mimetype: String, contentLength: Long) { + // Decode URL as Base 64 and then use it somehow - i.e. save to device, share to another App, etc. + } +} +``` + +### File choosing +**API Docs:** [MiniAppFileChooser](api/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-chooser/) + +The mini app is able to choose the file which is requested using HTML forms with 'file' input type whenever users press a "Select file" button. +HostApp can use a default class provided by the SDK e.g. `MiniAppFileChooserDefault` to choose the files. +- At first, HostApp needs to initiate `MiniAppFileChooserDefault` in the `Activity`. + +```kotlin +val fileChoosingReqCode = REQUEST_CODE // define a request code in HostApp +val miniAppFileChooser = MiniAppFileChooserDefault(requestCode = fileChoosingReqCode) +``` + +- Then, HostApp activity can receive the files at `onActivityResult` as following: + +```kotlin +override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) { + super.onActivityResult(requestCode, resultCode, data) + + // HostApp can cancel the file choosing operation when resultCode doesn't match + if (Activity.RESULT_OK != resultCode) { + miniAppFileChooser.onCancel() + } + + if (requestCode == fileChoosingReqCode && resultCode == Activity.RESULT_OK) { + data?.let { intent -> + miniAppFileChooser.onReceivedFiles(intent) + } + } +} +``` + +Alternatively, HostApp can use `MiniAppFileChooser` interface to override `onShowFileChooser` for customizing file choosing mode and other options. + +```kotlin +val miniAppFileChooser = object : MiniAppFileChooser { + + override fun onShowFileChooser( + filePathCallback: ValueCallback>?, + fileChooserParams: WebChromeClient.FileChooserParams?, + context: Context + ): Boolean { + // write own implementation here. + } + } +``` + +In both case, HostApp needs to pass `MiniAppFileChooser` through `MiniApp.create(appId: String, miniAppMessageBridge: MiniAppMessageBridge, miniAppFileChooser: MiniAppFileChooser)`. + +In case, MiniApp needs to check camera permission or request camera access from HostApp. + +```kotlin +val miniAppCameraPermissionDispatcher = object : MiniAppCameraPermissionDispatcher { + + override fun getCameraPermission(permissionCallback: (isGranted: Boolean) -> Unit) { + // Check the camera permission of the Device and send it back - i.e. isGranted = true/false. + if (DeviceCameraPermissionGranted) + permissionCallback(true) + else + permissionCallback(false) + } + + override fun requestCameraPermission( + miniAppPermissionType: MiniAppDevicePermissionType, + callback: (isGranted: Boolean) -> Unit + ) { + // Request the camera permission of the Device send send it back through callback. + callback.invoke(true) + } + } +``` + +Dispatch the `miniAppCameraPermissionDispatcher` with the `MiniAppFileChooserDefault`. + +```kotlin +val fileChoosingReqCode = REQUEST_CODE // define a request code in HostApp +val miniAppFileChooser = MiniAppFileChooserDefault( + requestCode = fileChoosingReqCode, + miniAppCameraPermissionDispatcher = miniAppCameraPermissionDispatcher +) +``` +`miniAppCameraPermissionDispatcher` is optional, No need to implement this if HostApp doesn't have camera permission in manifest or miniapp doesn't need to access camera. + +### File Downloading +**API Docs:** [MiniAppFileDownloader](api/com.rakuten.tech.mobile.miniapp.file/-mini-app-file-downloader/) + +The mini app is able to downlad a file on the local storage. HostApp can use a default class provided by the SDK e.g. `MiniAppFileDownloaderDefault` to download the files. +- At first, HostApp needs to initiate `MiniAppFileDownloaderDefault` in the `Activity`. + +```kotlin +val fileDownloadReqCode = REQUEST_CODE // define a request code in HostApp +val MiniAppFileDownloader = MiniAppFileDownloaderDefault(activity, requestCode = fileDownloadReqCode) +``` + +- Then set the `miniappFileDownloader` with the `miniAppMessageBridge`. +```kotlin +miniAppMessageBridge.setMiniAppFileDownloader(miniAppFileDownloader) +``` +- Then, HostApp activity can receive the file Uri on `onActivityResult` and pass the Uri to download the file. +```kotlin +if (requestCode == fileDownloadReqCode) { + intent?.data?.let { destinationUri -> + miniAppFileDownloader.onReceivedResult(destinationUri) + } +} +``` +Host app can also implement their own `miniAppFileDownloader` by implementing the `MiniAppFileDownloader` interface. +```kotlin +val miniAppFileDownloader = object : MiniAppFileDownloader{ + override fun onStartFileDownload( + fileName: String, + url: String, + headers: Map, + onDownloadSuccess: (String) -> Unit, + onDownloadFailed: (MiniAppDownloadFileError) -> Unit + ) { + //.. Download the file + } +} +``` +### Custom Permissions +**API Docs:** [MiniApp.getCustomPermissions](api/com.rakuten.tech.mobile.miniapp/-mini-app/get-custom-permissions.html), [MiniApp.setCustomPermissions](api/com.rakuten.tech.mobile.miniapp/-mini-app/set-custom-permissions.html), [MiniApp.listDownloadedWithCustomPermissions](api/com.rakuten.tech.mobile.miniapp/-mini-app/list-downloaded-with-custom-permissions.html) + +MiniApp Android SDK supports list of Custom Permissions (`MiniAppCustomPermissionType`) and these can be stored and retrieved using the following public interfaces. + +#### Retrieving the Mini App Custom Permissions using MiniAppID +Custom permissions and its status can be retrieved using the following interface. `getCustomPermissions` will return `MiniAppCustomPermission` that contains the meta-info as a `Pair` of +name and grant result (`ALLOWED` or `DENIED`). The custom permissions are stored per each miniAppId. +```kotlin +val permissions = miniapp.getCustomPermissions(miniAppId) +``` + +#### Store the Mini App Custom Permissions +Custom permissions for a mini app are cached by the SDK and you can use the following interface to store permissions when needed. +```kotlin +var permissionPairs = listOf>() +// .. .. .. +val permissionsToSet = MiniAppCustomPermission(miniAppId, permissionPairs) +miniapp.setCustomPermissions(permissionsToSet) +``` + +#### List of downloaded Mini apps with Custom Permissions +```kotlin +val downloadedMiniApps = miniapp.listDownloadedWithCustomPermissions() +downloadedMiniApps.forEach { + val miniApp = it.first + val permissions = it.second + // Display permissions in view, etc.... +} +``` + +### Passing parameters to a miniapp + +For a mini app, you can pass query parameters as String using `MiniApp.create` to be appended with miniapp's url. +For example: `https://mscheme.1234/miniapp/index.html?param1=value1¶m2=value2` + +To load the miniapp following load function needed to call +```kotlin +class MiniAppActivity : Activity(), CoroutineScope { + + override fun onCreate(savedInstanceState: Bundle?) { + //... + val param = MiniAppParameters.DefaultParams( + context = this, + config = MiniAppConfig( + miniAppSdkConfig = miniAppSdkConfig, + miniAppMessageBridge = miniAppMessageBridge, + miniAppNavigator = miniAppNavigator, + miniAppFileChooser = miniAppFileChooser, + queryParams = "" + ), + miniAppId = "id", + miniAppVersion = "version", + fromCache = false + ) + + val miniapp = MiniAppView.init(param) + miniapp.load(queryParams = urlParameters) { display, exception -> + + } + //... + } + +} +``` + +### Analytics events + +When [Analytics SDK](https://github.com/rakutentech/android-analytics) is integrated, MiniApp SDK sends analytics data from your app when some events are triggered: + +- HostApp starts with MiniApp SDK. +- When miniapp is launched. +- When miniapp is closed. + +## Troubleshooting & FAQs + +
Exception: "Network requests must not be performed on the main thread." + + +Some of the suspending functions in this SDK will perform network requests (`MiniApp.create`, `MiniApp.fetchInfo`, `MiniApp.listMiniApp`). Network requests should not be performed on the main thread, so the above exception will occur if your Coroutine is running in the `Dispatchers.Main` CoroutineContext. To avoid this exception, please use the `Dispatchers.IO` or `Dispatchers.Default` context instead. You can use [`withContext`](https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines/with-context.html) to make sure your code is running in the appropriate CoroutineContext. + +```kotlin +CoroutineScope(Dispatchers.Main).launch { + withContext(Dispatchers.IO) { + // Call MiniApp suspending function i.e. `MiniApp.create` + // This runs in a background thread + } + + // Update your UI - i.e. `setContentView(miniAppView)` + // This runs on the main thread +} +``` +
+ +
Exception: MiniAppVerificationException + + +This exception will be thrown when the SDK cannot verify the security check on local storage using keystore which means that users are not allowed to use miniapp. +Some keystores within devices are tampered or OEM were shipped with broken keystore from the beginning. + +
+ +
Build Error: `java.lang.RuntimeException: Duplicate class com.rakuten.tech.mobile.manifestconfig.annotations.ManifestConfig` + + +This build error could occur if you are using older versions of other libraries from `com.rakuten.tech.mobile`. +Some of the dependencies in this SDK have changed to a new Group ID of `io.github.rakutentech` (due to the [JCenter shutdown](https://jfrog.com/blog/into-the-sunset-bintray-jcenter-gocenter-and-chartcenter/)). +This means that if you have another library in your project which depends on the older dependencies using the Group ID `com.rakuten.tech.mobile`, then you will have duplicate classes. + +To avoid this, please add the following to your `build.gradle` in order to exclude the old `com.rakuten.tech.mobile` dependencies from your project. + +```groovy +configurations.all { + exclude group: 'com.rakuten.tech.mobile', module: 'manifest-config-processor' + exclude group: 'com.rakuten.tech.mobile', module: 'manifest-config-annotations' +} + +``` + +
+ +
How do I use snapshot versions of this SDK? + + +We may periodically publish snapshot versions for testing pre-release features. These versions will always end in `-SNAPSHOT`, for example `1.0.0-SNAPSHOT`. If you wish to use a snapshot version, you will need to add the snapshot repo to your Gradle configuration. + +``` +repositories { + maven { url 'https://s01.oss.sonatype.org/content/repositories/snapshots/' } +} + +dependency { + implementation 'io.github.rakutentech.miniapp:miniapp:X.X.X-SNAPSHOT' +} +``` +
+ +
How do I deep link to mini apps? + + +If you want to have deep links direclty to your mini apps, then you must implement deep link handling within your App. This can be done using either a custom deep link scheme (such as `myAppName://miniapp`) or an [App Link](https://developer.android.com/training/app-links) (such as `https://www.example.com/miniapp`). See the following Android Developer resources for more information on how to implement deep linking capabilities: + +- [Create Deep Links to App Content](https://developer.android.com/training/app-links/deep-linking) +- [Handling App Links](https://developer.android.com/training/app-links) +- [Verify Android App Links](https://developer.android.com/training/app-links/verify-site-associations) + +After you have implemented deep linking capabilities in your App, then you can configure your deep link to open and launch a Mini App. Note that your deep link should contain information about which mini app ID to open. Also, you can pass query parameters and a URL fragment to the mini app. The recommended deep link format is similar to `https://www.example.com/miniapp/MINI_APP_ID?myParam=myValue#myFragment` where the `myParam=myValue#myFragment` portion is optional and will be passed directly to the mini app. + +The following is an example which will parse the mini app ID and query string from a deep link intent: + +```kotlin +// In your main Activity +override fun onCreate(savedInstanceState: Bundle?) { + super.onCreate(savedInstanceState) + setContentView(R.layout.main) + + val action: String? = intent?.action + val uri: Uri? = intent?.data + + if (action == Intent.ACTION_VIEW && uri != null) { + handleDeepLink(uri) + } +} + +fun handleDeepLink(uri: Uri) { + if (uri.path?.startsWith("/miniapp") == true && uri.lastPathSegment != null) { + val miniAppId = uri.lastPathSegment + val queryParams = uri.query ?: "" + val queryFragment = uri.fragment ?: "" + val query = "$queryParams#$queryFragment" + + // Note that `MyMiniAppDisplayScreen` is just a placeholder example for your own class + // Inside this class you should call `MiniApp.create` in order to create and display the mini app + MyMiniAppDisplayScreen.launch(miniAppId, query) + } +} +``` + +
+ +
How do I clear the session data for Mini Apps? + + +In the case that a user logs out of your App, you should clear the session data for all of your Mini Apps. This will ensure that the next user does not have access to the stored sensitive information about the previous user such as Local Storage, IndexedDB, and Web SQL. + +The session data can be cleared by using the following: + +```kotlin +// Should be called after the User logs out +WebStorage.getInstance().deleteAllData() +CookieManager.getInstance().removeAllCookies {} +WebViewDatabase.getInstance(this).clearHttpAuthUsernamePassword() +``` + +**Note:** This will also clear the storage, cookies, and authentication data for ALL WebViews used by your App. +
+ +
How can I use this SDK in a Java project? + + +We don't support usage of the Mini App SDK in a Java project. This is because this SDK uses Kotlin specific features such as `suspend` functions and `Coroutines`. + +However, it is possible to use this SDK in a Java project if you wrap the calls to `suspend` functions into something that Java can use such as a `Future` or a normal callback interface. + +To do this, you will need to integrate Kotlin and Kotlin Coroutines into your project: + +```groovy +// In your top level "build.gradle" file: +buildscript { + dependencies { + classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:1.3.50" + } +} + +// In your project "myApp/build.gradle" file +apply plugin: 'kotlin-android' + +dependencies { + implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.3.50" + implementation "org.jetbrains.kotlinx:kotlinx-coroutines-jdk8:1.3.0" // Needed if you want to use CoroutineScope.future +} +``` + +Then, you will need to create wrapper functions for the Mini App SDK functionality which you wish to use. + +If your minimum Android API level is 24 or higher, then you can use Java [`CompletableFuture`](https://developer.android.com/reference/java/util/concurrent/CompletableFuture): + +```kotlin +// MiniAppAsync.kt + +private val coroutineScope = CoroutineScope(Dispatchers.Default) + +fun createMiniAppAsync( + appId: String, + miniAppMessageBridge: MiniAppMessageBridge, + miniAppNavigator: MiniAppNavigator? +): CompletableFuture = coroutineScope.future { + MiniApp.instance().create(appId, miniAppMessageBridge, miniAppNavigator) +} +``` + +If your minimum Android API level is lower than 24, then you can use a normal Java callback interface: + +```kotlin +// MiniAppAsync.kt + +interface MiniAppCallback { + fun onSuccess(result: T) + fun onError(error: MiniAppSdkException) +} + +val coroutineScope = CoroutineScope(Dispatchers.Default) + +fun createMiniAppAsync( + appId: String, + miniAppMessageBridge: MiniAppMessageBridge, + miniAppNavigator: MiniAppNavigator?, + callback: MiniAppCallback +) { + coroutineScope.launch { + try { + val display = MiniApp.instance().create(appId, miniAppMessageBridge, miniAppNavigator) + callback.onSuccess(display) + } catch (error: MiniAppSdkException) { + callback.onError(error) + } + } +} +``` +
+ +
How to override text for localization purpose? + + +The MiniApp SDK provides the default UI (i.e custom permission window) when your app does not have own UI implementation. + +In case you want to use the default UI and only change text display, you can override the string values in [here](https://github.com/rakutentech/android-miniapp/blob/master/miniapp/src/main/res/values/strings.xml). +Just need to place them in your app `strings.xml` with the same key. You can also put them in different localization resource directory. + +Example: We want to change `Save` in another locale text. + +```xml + + +γ‚»γƒΌγƒ– +``` +
+ +## Changelog + +See the full [CHANGELOG](https://github.com/rakutentech/android-miniapp/blob/master/CHANGELOG.md).