Method Loop Expansion Tokens

Method Loop Token

Description

<CUSTOM_METHOD_token>

Custom method loop expansion tokens allow you to insert content defined by custom expansion tokens defined in a method catalog extensions file. Note that custom expansion token names are not not case sensitive, always being converted to uppercase for comparison, but that the associated values are, being inserted exactly as defined in the extensions file.

<METHOD_ATTRIBUTE>

Inserts a Synergy {xfMethod} attribute for the current method.

<METHOD_COMMENT>

If the method has an associated comment then this token inserts that comment text.

<METHOD_ENCRYPT>

Inserts a boolean value indicating whether the current method requires over-the-wire encryption.

Possible values:  True, False

<METHOD_ELB>

Inserts the file specification of the ELB containing the current method.

<METHOD_ID>

Inserts the unique and case-sensitive ID of the current method.

<METHOD_NAME>

Inserts the name of the current method.

Alternates: <method_name>, <Method_Name>, <Methood_name>, <MethodName>, <methodName>

<METHOD_PARAMETERS>

Inserts the number of parameters that the current method has.

<METHOD_RETURN_COERCE_TYPE>

Inserts the coerce type associated with the current methods return value.

Possible values:  None, Boolean, Byte, DateTime, DateTimeNullable, Decimal, DecimalNullable, Double, Float, Int, Long, Sbyte, Short, Uint, Ulong, Ushort

<METHOD_RETURN_COMMENT>

If the method return value has an associated comment then this token inserts that text.

<METHOD_RETURN_CSTYPE_XF>

Inserts the C# data type that xfNetLink .NET would use to represent the return type of the method.

<METHOD_RETURN_DATE_FORMAT>

Inserts the date format associated with the method return value.

Possible values:  None, YYYYMMDD, YYMMDD, YYJJJ, YYYYJJJ, HHMM, HHMMSS, YYYYMMDDHHMISS, YYYYMMDDHHMISSUUUUU

<METHOD_RETURN_ENUM>

If the methods return type is defined by an ENUM then this token inserts the name of that ENUM.

<METHOD_RETURN_PRECISION>

If the methods return value is implied decimal, this token inserts the precision (number of digits after the decimal point), otherwise nothing is inserted.

<METHOD_RETURN_SAMPLE_DATA>

Inserts sample date for the methods return value. This token is intended to be used for the generation of examples in documentation or API references.

<METHOD_RETURN_SIZE>

If the method has a return value then this token inserts the length of the returned data, otherwise nothing is inserted.

<METHOD_RETURN_TSTYPE>

If the method has a return value then this token inserts the TypeScript compatible type of that return value.

Possible values:  boolean, string, Date, Nullable<Date>, number

<METHOD_RETURN_TYPE>

Inserts the return type of the current method.

Possible values:  <blank string>, A<size>, D<size>, D<size>.<precision>, <enumName>, I<size>, ^VAL, STRING

Alternates:  <method_return_type>

<METHOD_ROUTINE>

Inserts the name of the synergy routine associated with the current method.

<METHOD_TYPE>

Inserts the type of routine associated with the current method.

Possible values:  SUBROUTINE, FUNCTION

Alternates:  <method_type>