pCon.basket - Plugin Development
    Preparing search index...

    Interface CommonResources

    Provides commonly used localized resources. The current language of the application will be used as resource language.

    interface CommonResources {
        buttonAbort: string;
        buttonApply: string;
        buttonCancel: string;
        buttonContinue: string;
        buttonDone: string;
        buttonNo: string;
        buttonOk: string;
        buttonYes: string;
        calcDataCondAmount: string;
        calcDataCondDescription: string;
        calcDataCondType: string;
        calcDataCondValue: string;
        calcDataItemQuantity: string;
        confirmationInconsistentArticles: string;
        confirmationLogout: string;
        contactDataBillingAddress: string;
        contactDataCity: string;
        contactDataCompany: string;
        contactDataConditionNumber: string;
        contactDataCountry: string;
        contactDataCustomerNumber: string;
        contactDataDepartment: string;
        contactDataDistrict: string;
        contactDataEmail: string;
        contactDataFax: string;
        contactDataFirstName: string;
        contactDataGeneralAgreementNumber: string;
        contactDataLastName: string;
        contactDataMainAddress: string;
        contactDataMobile: string;
        contactDataPhone: string;
        contactDataPOBox: string;
        contactDataPOBoxPostcode: string;
        contactDataPosition: string;
        contactDataPostcode: string;
        contactDataRegion: string;
        contactDataRemarks: string;
        contactDataSalutation: string;
        contactDataSalutationMr: string;
        contactDataSalutationMrs: string;
        contactDataShippingAddress: string;
        contactDataStreet: string;
        contactDataWebsite: string;
        errorExportFailed: string;
        errorImportFailed: string;
        errorInsertArticleFailed: string;
        errorInvalidUsernameOrPassword: string;
        errorOpenProjectFailed: string;
        errorOpenQuoteFailed: string;
        errorSaveProjectFailed: string;
        errorSaveQuoteFailed: string;
        errorStartSessionFailed: string;
        errorUnexpected: string;
        itemArticleGroupPriceInfo: string;
        itemDataArticleNumber: string;
        itemDataFeatureText: string;
        itemDataLongText: string;
        itemDataManufacturer: string;
        itemDataManufacturerId: string;
        itemDataPackagingNetWeight: string;
        itemDataPackagingVolume: string;
        itemDataPriceDate: string;
        itemDataPurchasePrice: string;
        itemDataSalesPrice: string;
        itemDataSeries: string;
        itemDataSeriesId: string;
        itemDataShortText: string;
        itemDataUserFeatureText: string;
        itemDataUserLongText: string;
        itemDataUserShortText: string;
        itemInactiveStateAlternative: string;
        itemInactiveStateOptional: string;
        labelClose: string;
        labelCopy: string;
        labelCut: string;
        labelDeleteDefaults: string;
        labelDownload: string;
        labelError: string;
        labelExport: string;
        labelImport: string;
        labelInconsistenArticles: string;
        labelLogin: string;
        labelLogout: string;
        labelOpen: string;
        labelPaste: string;
        labelSave: string;
        labelSaveAs: string;
        labelSaveAsDefault: string;
        labelShare: string;
        labelUnsupportedFile: string;
        labelUnsupportedImage: string;
        labelUpload: string;
        noticeObkImport: string;
        placeholderUnnamed: string;
        projectDataDate: string;
        projectDataDescription: string;
        projectDataExtRefNumber: string;
        projectDataExtRefText: string;
        projectDataKeywords: string;
        projectDataName: string;
        projectDataPersonInCharge: string;
        projectDataPriceList: string;
        projectDataProjectGroup: string;
        projectDataProjectNumber: string;
        projectDataStatus: string;
        projectDataTermsAndConditions: string;
        projectStatusApprovalDenied: string;
        projectStatusApprovalRequired: string;
        projectStatusApproved: string;
        projectStatusInProgress: string;
        projectStatusNotCommissioned: string;
        projectStatusOffered: string;
        projectStatusOrdered: string;
        projectStatusUndefined: string;
        projectStatusWaitingForApproval: string;
        quoteDataDate: string;
        quoteDataLanguage: string;
        quoteDataQuoteNumber: string;
        quoteDataValidToDate: string;
        getBasketItemCurrencyConversionText(
            pOptions: BasketItemCurrencyConversionTextOptions,
        ): string | null;
        getBasketItemWarningText(
            pItemProps: ItemProperties | null | undefined,
            pItemCalculation: CalculationSheetInfo | null | undefined,
        ): string | null;
        getCalculationErrorText(
            pCalculation: CalculationSheetInfo | null | undefined,
            pIncludeGroupErrors: boolean,
        ): string | null;
        getCalendarStrings(): CalendarStrings;
        getCountries(pContext: EaiwsContext): Promise<CountryData[]>;
        getCountryName(
            pContext: EaiwsContext,
            pCountryCode: string,
        ): Promise<string | null>;
        getCountrySubdivisions(
            pContext: EaiwsContext,
            pCountryCode: string,
        ): Promise<SubdivisionData[]>;
        getCurrencyName(pCurrencyCode: string): string | null;
        getDataLanguages(): Map<string, LanguageInfo>;
        getDayNames(): string[];
        getDayNamesNarrow(): string[];
        getEaiwsPriceListName(pPriceList: PriceList): string;
        getEaiwsProjectGroupName(
            pProjectGroup: ProjectGroup,
            pPreferFullName: boolean,
        ): string;
        getKeyboardShortcutText(
            pKey: string,
            pOptions?: KeyboardShortcutTextOptions,
        ): string;
        getMonthNames(): string[];
        getMonthNamesAbbreviated(): string[];
        getRegionName(
            pContext: EaiwsContext,
            pCountryCode: string,
            pRegionCode: string,
        ): Promise<string | null>;
        getUnsupportedFileFormatText(pSupportedFormats: string): string;
    }
    Index
    buttonAbort buttonApply buttonCancel buttonContinue buttonDone buttonNo buttonOk buttonYes calcDataCondAmount calcDataCondDescription calcDataCondType calcDataCondValue calcDataItemQuantity confirmationInconsistentArticles confirmationLogout contactDataBillingAddress contactDataCity contactDataCompany contactDataConditionNumber contactDataCountry contactDataCustomerNumber contactDataDepartment contactDataDistrict contactDataEmail contactDataFax contactDataFirstName contactDataGeneralAgreementNumber contactDataLastName contactDataMainAddress contactDataMobile contactDataPhone contactDataPOBox contactDataPOBoxPostcode contactDataPosition contactDataPostcode contactDataRegion contactDataRemarks contactDataSalutation contactDataSalutationMr contactDataSalutationMrs contactDataShippingAddress contactDataStreet contactDataWebsite errorExportFailed errorImportFailed errorInsertArticleFailed errorInvalidUsernameOrPassword errorOpenProjectFailed errorOpenQuoteFailed errorSaveProjectFailed errorSaveQuoteFailed errorStartSessionFailed errorUnexpected itemArticleGroupPriceInfo itemDataArticleNumber itemDataFeatureText itemDataLongText itemDataManufacturer itemDataManufacturerId itemDataPackagingNetWeight itemDataPackagingVolume itemDataPriceDate itemDataPurchasePrice itemDataSalesPrice itemDataSeries itemDataSeriesId itemDataShortText itemDataUserFeatureText itemDataUserLongText itemDataUserShortText itemInactiveStateAlternative itemInactiveStateOptional labelClose labelCopy labelCut labelDeleteDefaults labelDownload labelError labelExport labelImport labelInconsistenArticles labelLogin labelLogout labelOpen labelPaste labelSave labelSaveAs labelSaveAsDefault labelShare labelUnsupportedFile labelUnsupportedImage labelUpload noticeObkImport placeholderUnnamed projectDataDate projectDataDescription projectDataExtRefNumber projectDataExtRefText projectDataKeywords projectDataName projectDataPersonInCharge projectDataPriceList projectDataProjectGroup projectDataProjectNumber projectDataStatus projectDataTermsAndConditions projectStatusApprovalDenied projectStatusApprovalRequired projectStatusApproved projectStatusInProgress projectStatusNotCommissioned projectStatusOffered projectStatusOrdered projectStatusUndefined projectStatusWaitingForApproval quoteDataDate quoteDataLanguage quoteDataQuoteNumber quoteDataValidToDate
    buttonAbort: string
    buttonApply: string
    buttonCancel: string
    buttonContinue: string
    buttonDone: string
    buttonNo: string
    buttonOk: string
    buttonYes: string
    calcDataCondAmount: string
    calcDataCondDescription: string
    calcDataCondType: string
    calcDataCondValue: string
    calcDataItemQuantity: string
    confirmationInconsistentArticles: string
    confirmationLogout: string
    contactDataBillingAddress: string
    contactDataCity: string
    contactDataCompany: string
    contactDataConditionNumber: string
    contactDataCountry: string
    contactDataCustomerNumber: string
    contactDataDepartment: string
    contactDataDistrict: string
    contactDataEmail: string
    contactDataFax: string
    contactDataFirstName: string
    contactDataGeneralAgreementNumber: string
    contactDataLastName: string
    contactDataMainAddress: string
    contactDataMobile: string
    contactDataPhone: string
    contactDataPOBox: string
    contactDataPOBoxPostcode: string
    contactDataPosition: string
    contactDataPostcode: string
    contactDataRegion: string
    contactDataRemarks: string
    contactDataSalutation: string
    contactDataSalutationMr: string
    contactDataSalutationMrs: string
    contactDataShippingAddress: string
    contactDataStreet: string
    contactDataWebsite: string
    errorExportFailed: string
    errorImportFailed: string
    errorInsertArticleFailed: string
    errorInvalidUsernameOrPassword: string
    errorOpenProjectFailed: string
    errorOpenQuoteFailed: string
    errorSaveProjectFailed: string
    errorSaveQuoteFailed: string
    errorStartSessionFailed: string
    errorUnexpected: string
    itemArticleGroupPriceInfo: string
    itemDataArticleNumber: string
    itemDataFeatureText: string
    itemDataLongText: string
    itemDataManufacturer: string
    itemDataManufacturerId: string
    itemDataPackagingNetWeight: string
    itemDataPackagingVolume: string
    itemDataPriceDate: string
    itemDataPurchasePrice: string
    itemDataSalesPrice: string
    itemDataSeries: string
    itemDataSeriesId: string
    itemDataShortText: string
    itemDataUserFeatureText: string
    itemDataUserLongText: string
    itemDataUserShortText: string
    itemInactiveStateAlternative: string
    itemInactiveStateOptional: string
    labelClose: string
    labelCopy: string
    labelCut: string
    labelDeleteDefaults: string
    labelDownload: string
    labelError: string
    labelExport: string
    labelImport: string
    labelInconsistenArticles: string
    labelLogin: string
    labelLogout: string
    labelOpen: string
    labelPaste: string
    labelSave: string
    labelSaveAs: string
    labelSaveAsDefault: string
    labelShare: string
    labelUnsupportedFile: string
    labelUnsupportedImage: string
    labelUpload: string
    noticeObkImport: string
    placeholderUnnamed: string
    projectDataDate: string
    projectDataDescription: string
    projectDataExtRefNumber: string
    projectDataExtRefText: string
    projectDataKeywords: string
    projectDataName: string
    projectDataPersonInCharge: string
    projectDataPriceList: string
    projectDataProjectGroup: string
    projectDataProjectNumber: string
    projectDataStatus: string
    projectDataTermsAndConditions: string
    projectStatusApprovalDenied: string
    projectStatusApprovalRequired: string
    projectStatusApproved: string
    projectStatusInProgress: string
    projectStatusNotCommissioned: string
    projectStatusOffered: string
    projectStatusOrdered: string
    projectStatusUndefined: string
    projectStatusWaitingForApproval: string
    quoteDataDate: string
    quoteDataLanguage: string
    quoteDataQuoteNumber: string
    quoteDataValidToDate: string
    • Returns a text based on the current item status (e.g. inconsistency) which can be show as a warning to the user.

      Parameters

      • pItemProps: ItemProperties | null | undefined
      • pItemCalculation: CalculationSheetInfo | null | undefined

      Returns string | null

    • Returns an error text for the given calculation.

      Parameters

      • pCalculation: CalculationSheetInfo | null | undefined
      • pIncludeGroupErrors: boolean

      Returns string | null

    • Helper function to retrieve the countries from an eaiws session. This function caches the server response to speed up further calls.

      Parameters

      • pContext: EaiwsContext

      Returns Promise<CountryData[]>

    • Helper function to retrieve a localized country name from an eaiws session context. This function caches the server response to speed up further calls.

      Parameters

      • pContext: EaiwsContext
      • pCountryCode: string

      Returns Promise<string | null>

    • Helper function to retrieve the country subdivisions from an eaiws session context. This function caches the server response to speed up further calls.

      Parameters

      • pContext: EaiwsContext
      • pCountryCode: string

      Returns Promise<SubdivisionData[]>

    • Returns a localized name for the given currency code.

      Parameters

      • pCurrencyCode: string

      Returns string | null

    • Returns a map of supported data languages. The language iso code is used as key for the map.

      Returns Map<string, LanguageInfo>

    • Returns an array with day names starting with sunday.

      Returns string[]

    • Returns an array with narrow day names (e.g. S, M, T) starting with sunday.

      Returns string[]

    • Helper function to retrieve a localized name for the given price list.

      Parameters

      • pPriceList: PriceList

      Returns string

    • Helper function to retrieve a localized name for the given project group. If pPreferFullName is true, the full name of the group will be returned if available.

      Parameters

      • pProjectGroup: ProjectGroup
      • pPreferFullName: boolean

      Returns string

    • Returns an array with month names starting with january.

      Returns string[]

    • Returns an array with abbreviated month names (e.g. jan, feb) starting with january.

      Returns string[]

    • Helper function to retrieve a localized region/subdivision name from an eaiws session context. E.g. country = US, region = OH will return "Ohio" This function caches the server response to speed up further calls.

      Parameters

      • pContext: EaiwsContext
      • pCountryCode: string
      • pRegionCode: string

      Returns Promise<string | null>

    • Returns a text to inform the user that a file is not supopoted because of its file foramt.

      Parameters

      • pSupportedFormats: string

        List of supported file formats which will included in the text e.g. jpg, png

      Returns string