TESSA Web API
    Preparing search index...

    Interface IViewSpecialParameters

    interface IViewSpecialParameters {
        getCurrentCardIdParameter(
            cardId: string,
            hidden?: boolean,
            readOnly?: boolean,
        ): ViewRequestParameter;
        getCurrentCardIdParameterMetadata(hidden?: boolean): IViewParameterMetadata;
        getCurrentUserParameter(
            hidden?: boolean,
            readOnly?: boolean,
        ): ViewRequestParameter;
        getCurrentUserParameter(
            userId: string,
            userName: string,
            hidden?: boolean,
            readOnly?: boolean,
        ): ViewRequestParameter;
        getCurrentUserParameterMetadata(hidden?: boolean): IViewParameterMetadata;
        getFormatSettingsParameter(
            hidden?: boolean,
            readOnly?: boolean,
        ): ViewRequestParameter;
        getFormatSettingsParameter(
            formatName: string,
            text: string,
            hidden?: boolean,
            readOnly?: boolean,
        ): ViewRequestParameter;
        getFormatSettingsParameterMetadata(
            hidden?: boolean,
        ): IViewParameterMetadata;
        getLocaleParameter(
            hidden?: boolean,
            readOnly?: boolean,
        ): ViewRequestParameter;
        getLocaleParameter(
            localeCode: string,
            text: string,
            hidden?: boolean,
            readOnly?: boolean,
        ): ViewRequestParameter;
        getLocaleParameterMetadata(hidden?: boolean): IViewParameterMetadata;
        getMSSQLParameterMetadata(hidden?: boolean): IViewParameterMetadata;
        getPageLimitParameter(
            pageLimit?: number,
            hidden?: boolean,
            readOnly?: boolean,
        ): ViewRequestParameter;
        getPageLimitParameterMetadata(hidden?: boolean): IViewParameterMetadata;
        getPageOffsetParameter(
            currentPage?: number,
            pageLimit?: number,
            hidden?: boolean,
            readOnly?: boolean,
        ): ViewRequestParameter;
        getPageOffsetParameterMetadata(hidden?: boolean): IViewParameterMetadata;
        getPostgreSQLParameterMetadata(hidden?: boolean): IViewParameterMetadata;
        provideCurrentCardIdParameter(
            parameters: ViewRequestParameter[],
            cardId: string,
        ): void;
        provideCurrentUserIdParameter(parameters: ViewRequestParameter[]): void;
        provideFormatSettingsParameter(parameters: ViewRequestParameter[]): void;
        provideLocaleParameter(parameters: ViewRequestParameter[]): void;
        providePageLimitParameter(
            parameters: ViewRequestParameter[],
            paging: Paging,
            pageLimit: number,
            optionalPaging: boolean,
        ): void;
        providePageOffsetParameter(
            parameters: ViewRequestParameter[],
            paging: Paging,
            currentPage: number,
            pageLimit: number,
            optionalPaging: boolean,
        ): void;
        tryGetSpecialParameterMetadata(
            alias: string,
            hidden?: boolean,
        ): null | IViewParameterMetadata;
    }

    Implemented by

    Index

    Methods

    • Parameters

      • cardId: string
      • Optionalhidden: boolean
      • OptionalreadOnly: boolean

      Returns ViewRequestParameter

    • Parameters

      • Optionalhidden: boolean
      • OptionalreadOnly: boolean

      Returns ViewRequestParameter

    • Parameters

      • userId: string
      • userName: string
      • Optionalhidden: boolean
      • OptionalreadOnly: boolean

      Returns ViewRequestParameter

    • Parameters

      • Optionalhidden: boolean
      • OptionalreadOnly: boolean

      Returns ViewRequestParameter

    • Parameters

      • formatName: string
      • text: string
      • Optionalhidden: boolean
      • OptionalreadOnly: boolean

      Returns ViewRequestParameter

    • Parameters

      • Optionalhidden: boolean
      • OptionalreadOnly: boolean

      Returns ViewRequestParameter

    • Parameters

      • localeCode: string
      • text: string
      • Optionalhidden: boolean
      • OptionalreadOnly: boolean

      Returns ViewRequestParameter

    • Parameters

      • OptionalpageLimit: number
      • Optionalhidden: boolean
      • OptionalreadOnly: boolean

      Returns ViewRequestParameter

    • Parameters

      • OptionalcurrentPage: number
      • OptionalpageLimit: number
      • Optionalhidden: boolean
      • OptionalreadOnly: boolean

      Returns ViewRequestParameter

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      • alias: string
      • Optionalhidden: boolean

      Returns null | IViewParameterMetadata