You can use these predefined model-pattern methods when your model is run by an MDriven server; this page is for MDriven Designer users who need to know which method names have built-in server implementations.

What pattern-supported methods are

A pattern-supported method is a method on a model-pattern class for which the server provides the implementation. You add or merge the relevant model pattern into your model, then call the method by its exact class and method name. Do not create a same-named method on an unrelated class and expect the server implementation to run.

For example, after adding the SysUserAuthentication pattern, the SysUser.HashPassword method is available for password-hash handling. The pattern documentation describes the SysUser model and its authentication use case.

This list identifies method names supported by the server. It does not replace the documentation for the individual pattern, and it does not define argument or return types where those are not documented here.

Use a supported method

1. Add the model pattern that defines the class to your model. For Turnkey patterns, merge the pattern from TK Live View where the pattern documentation instructs you to do so.
2. In MDriven Designer, locate the method on the pattern class and preserve its exact name.
3. Call the method from the appropriate model expression or action.
4. Run the model on the server that supports the pattern method.
5. Test with representative input and handle any result or failure according to the pattern's contract.

A method defined in a model is normally implemented with OCL and EAL. A pattern-supported method is different: its implementation is supplied by the server. If you define your own method, you must provide its model implementation and, when applicable, set IsQuery only when the method has no intentional side effects.

Turnkey-only methods

The following methods have built-in support in MDriven Turnkey. Method names are case-sensitive.

Pattern class	Supported methods	Typical purpose indicated by the name
ZXing	QRImage BarcodeImage	QR-code and barcode image generation.
SysOpenAIChatSession	Generate	Generate a chat-session result.
LiveUpdate	Perform	Perform a live-update operation.
SysUser	HashPassword VerifyHashedPassword Consume GetSecurityStamp GetPurchaseUrl Office365RefreshAccessToken OpenIdConnectAccessTokenRefresh	User, password, security-stamp, purchase URL, and external-token operations. See SysUserAuthentication for the documented user and password methods.
SysGraphAPI	GetDecodedAccessToken GetDecodedRefreshToken GetUsersFromGroupId GetGroupsFromPrincipalUser GetUsers Search LookUpFromUrl LookUpLocationFromDriveIdAndId LookUpFromDriveIdAndIdAndVersion DriveDriveItemToThumbnailUrl DriveDriveItemToThumbnailData GetContentFromDriveIdAndIdAndVersion AdHocGetQuery	Graph API token, user, group, search, lookup, thumbnail, content, and query operations.
SysGraphAPIResultRow	NavigateDownInFolder NavigateUpToParentFolder	Folder navigation for a Graph API result row.
SysSingleton	GetSystemUrl SHA512ComputeHash SHA256ComputeHash BitConverterToString GenerateTokenJWT GenerateTokenJWTWithSysCert GenerateTokenSAML2 GenerateTokenSAML2WithSysCert VerifySAML2 VerifyJWT Deflate UrlEncode	System URL, hashing, conversion, token generation and verification, compression, and URL encoding.
SysCert	GetAsCertString InitFromCertString GenerateRSAParams RSADecrypt RSAEncrypt	Certificate serialization and initialization, plus RSA parameter, encryption, and decryption operations.

Example: password hashing

The SysUserAuthentication pattern documents SysUser.HashPassword as taking a pwd:String argument and returning a password hash. Use the pattern's documented password flow rather than storing a plaintext password. The pattern also documents SetPassword, which uses HashPassword to set PasswordHash.

Other listed server-supported methods

The source list also identifies these methods outside the Turnkey-only section. Confirm the server environment and the pattern contract before depending on them.

Pattern class	Supported methods	Typical purpose indicated by the name
SysDoc	ConvertToMSOfficeWithLibreOffice ConvertToPDFWithLibreOffice	Document conversion using LibreOffice.
SysViewStateCookie	FillWithCurrentView	Fill the view-state cookie with the current view.

Important limits

• Built-in support applies to the listed class-and-method combinations only. For example, SysSingleton.SHA256ComputeHash and a method named SHA256ComputeHash on another class are not the same method.
• The method list is not a substitute for a pattern definition. Add the relevant pattern before calling its methods.
• Do not infer parameter lists, return values, security requirements, or external-service configuration from a method name. Use the relevant pattern documentation and inspect the merged model definition.
• Security-related methods, including password, token, certificate, encryption, and decryption methods, require careful handling. Do not expose secrets, passwords, certificate material, access tokens, or refresh tokens in views or logs.
• If a method is not listed here, implement the method in your model as described in Methods, unless its pattern documentation states that the server supports it.

See also

• Documentation:Methods
• Documentation:SysUserAuthentication
• MDriven learning index