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;} Methods
getCurrentCardIdParameter
getCurrentCardIdParameter( cardId: string, hidden?: boolean, readOnly?: boolean,): ViewRequestParameter Parameters
- cardId: string
Optional
hidden: booleanOptional
readOnly: boolean
getCurrentCardIdParameterMetadata
getCurrentUserParameter
Parameters
Optional
hidden: booleanOptional
readOnly: boolean
getCurrentUserParameter( userId: string, userName: string, hidden?: boolean, readOnly?: boolean,): ViewRequestParameter Parameters
- userId: string
- userName: string
Optional
hidden: booleanOptional
readOnly: boolean
getCurrentUserParameterMetadata
getFormatSettingsParameter
Parameters
Optional
hidden: booleanOptional
readOnly: boolean
getFormatSettingsParameter( formatName: string, text: string, hidden?: boolean, readOnly?: boolean,): ViewRequestParameter Parameters
- formatName: string
- text: string
Optional
hidden: booleanOptional
readOnly: boolean
getFormatSettingsParameterMetadata
getLocaleParameter
Parameters
Optional
hidden: booleanOptional
readOnly: boolean
getLocaleParameter( localeCode: string, text: string, hidden?: boolean, readOnly?: boolean,): ViewRequestParameter Parameters
- localeCode: string
- text: string
Optional
hidden: booleanOptional
readOnly: boolean
getLocaleParameterMetadata
getMSSQLParameterMetadata
getPageLimitParameter
getPageLimitParameter( pageLimit?: number, hidden?: boolean, readOnly?: boolean,): ViewRequestParameter Parameters
Optional
pageLimit: numberOptional
hidden: booleanOptional
readOnly: boolean
getPageLimitParameterMetadata
getPageOffsetParameter
getPageOffsetParameter( currentPage?: number, pageLimit?: number, hidden?: boolean, readOnly?: boolean,): ViewRequestParameter Parameters
Optional
currentPage: numberOptional
pageLimit: numberOptional
hidden: booleanOptional
readOnly: boolean
getPageOffsetParameterMetadata
getPostgreSQLParameterMetadata
provideCurrentCardIdParameter
Returns void
provideCurrentUserIdParameter
Returns void
provideFormatSettingsParameter
Returns void
provideLocaleParameter
Returns void
providePageLimitParameter
Returns void
providePageOffsetParameter
providePageOffsetParameter( parameters: ViewRequestParameter[], paging: Paging, currentPage: number, pageLimit: number, optionalPaging: boolean,): void Returns void
tryGetSpecialParameterMetadata
Parameters
- alias: string
Optional
hidden: boolean