IOrganizationLocalizationService
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Reads how languages and translations are used across the organization.
export interface IOrganizationLocalizationService
Methods
Method | Description |
|---|---|
(ALPHA) List the languages with translations in the organization. | |
(ALPHA) List translation coverage per workspace. | |
(ALPHA) Count the workspaces and people that miss a translation, or do not use an available one. | |
(ALPHA) Summarize language usage across all workspaces and people. | |
(ALPHA) List the people behind a usage count, sorted by name. | |
(ALPHA) List the workspaces behind a usage count, sorted by name. |
Method details
IOrganizationLocalizationService.getStatistics()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
List the languages with translations in the organization.
getStatistics(): Promise<ILocalizationStatistics>;
Returns
Promise<ILocalizationStatistics>
IOrganizationLocalizationService.getStatisticsWorkspaces()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
List translation coverage per workspace.
getStatisticsWorkspaces(query?: ILocalizationPageQuery): Promise<ILocalizationStatisticsWorkspacesPage>;
Parameters
Parameter | Type | Description |
|---|---|---|
query | (Optional) |
Returns
IOrganizationLocalizationService.getTranslationUsage()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Count the workspaces and people that miss a translation, or do not use an available one.
getTranslationUsage(): Promise<ILocalizationTranslationUsage>;
Returns
Promise<ILocalizationTranslationUsage>
IOrganizationLocalizationService.getUsage()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Summarize language usage across all workspaces and people.
getUsage(): Promise<ILocalizationUsage>;
Returns
Promise<ILocalizationUsage>
IOrganizationLocalizationService.getUsageUsers()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
List the people behind a usage count, sorted by name.
getUsageUsers(query?: ILocalizationUsageListQuery): Promise<ILocalizationUsageUsersPage>;
Parameters
Parameter | Type | Description |
|---|---|---|
query | (Optional) |
Returns
Promise<ILocalizationUsageUsersPage>
IOrganizationLocalizationService.getUsageWorkspaces()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
List the workspaces behind a usage count, sorted by name.
getUsageWorkspaces(query?: ILocalizationUsageListQuery): Promise<ILocalizationUsageWorkspacesPage>;
Parameters
Parameter | Type | Description |
|---|---|---|
query | (Optional) |
Returns
Promise<ILocalizationUsageWorkspacesPage>