IMTenant Provider
プラットフォーム
- ios
- android
概要
IMTenantは他のAPIに同一のbaseUrl、tenantIdを共有するために存在します。
ここでPropsに設定されたbaseUrl、tenantIdはIMOAuthやIMFetchを始めとした他のAPIで利用されます。
このためIMTenantは常に他のAPIより上位層に配置する必要があります。
Provider
このProviderはネストされたコンポーネントで同一のbaseUrl、tenantIdを利用できるようにします。
import { IMTenant } from "@intra-mart/smartlime";
const App = () => {
return (
<IMTenant
baseUrl={'https://example.org/imart'}
tenantId={'default'}
>
</IMTenant>;
)
}
Props
Name | Type | Required | Default |
---|---|---|---|
baseUrl | string | yes | |
tenantId | string | yes | |
tenantContext | Context | no |
baseUrl
あなたのiAPのURLを設定します。 ここで設定されたURLは他のAPIで利用されます。
tenantId
備考
将来的な機能のために用意されています。
現在この値は特に意味を持ちません。
tenantContext
context instanceを設定します。
このPropを設定した場合、ネストされたコンポーネント全てでも同じcontextを利用しなければならない事に注意してください。
あなたがcontextについて詳しく知らない場合このオプションは利用するべきではありません。