Interface ShowOrganizationForTenantOptions<TOrganizationCustomFields>

interface ShowOrganizationForTenantOptions<TOrganizationCustomFields> {
    services: {
        organizationApi: Pick<OrganizationApi, "getOrganization">;
    };
    settings: {
        demandSiteOrganizationUrl: string;
        editOrganizationRoute: string;
    };
    views?: {
        Page?: ComponentClass<ShowOrganizationForTenantDefaultPageViewProps<TOrganizationCustomFields>, any> | FunctionComponent<ShowOrganizationForTenantDefaultPageViewProps<TOrganizationCustomFields>>;
    };
}

Type Parameters

  • TOrganizationCustomFields

Properties

services settings views?

Properties

services

services: {
    organizationApi: Pick<OrganizationApi, "getOrganization">;
}

Type declaration

  • organizationApi: Pick<OrganizationApi, "getOrganization">

    The client API for organizations

settings

settings: {
    demandSiteOrganizationUrl: string;
    editOrganizationRoute: string;
}

Type declaration

  • demandSiteOrganizationUrl: string

    URL of the demand website for this org. This will perform a replace on :organizationId with the tenant ID.

  • editOrganizationRoute: string

    Route to edit organization

Optional views

views?: {
    Page?: ComponentClass<ShowOrganizationForTenantDefaultPageViewProps<TOrganizationCustomFields>, any> | FunctionComponent<ShowOrganizationForTenantDefaultPageViewProps<TOrganizationCustomFields>>;
}

Type declaration

  • Optional Page?: ComponentClass<ShowOrganizationForTenantDefaultPageViewProps<TOrganizationCustomFields>, any> | FunctionComponent<ShowOrganizationForTenantDefaultPageViewProps<TOrganizationCustomFields>>

    Customization for the view of this block. If not provided, the default view will be used, which is a simple page using the ShowPage component with no custom fields.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc