FunctionsNewAsync Method

Linkar Framework for .NET and Core

Creates one or several records of a file, in a asynchronous way with JSON input and output format.

Namespace: Linkar.Functions.Direct.JSON
Assembly: Linkar.Functions.Direct.JSON (in Linkar.Functions.Direct.JSON.dll) Version: 2.3.1

Syntax

C++

Copy

public static Task<string> NewAsync(
	CredentialOptions credentialOptions,
	string filename,
	string records,
	NewOptions newOptions = null,
	FunctionsJSON_FORMAT jsonFormat = FunctionsJSON_FORMAT.JSON,
	string customVars = "",
	int receiveTimeout = 0
)

Public Shared Function NewAsync ( 
	credentialOptions As CredentialOptions,
	filename As String,
	records As String,
	Optional newOptions As NewOptions = Nothing,
	Optional jsonFormat As FunctionsJSON_FORMAT = FunctionsJSON_FORMAT.JSON,
	Optional customVars As String = "",
	Optional receiveTimeout As Integer = 0
) As Task(Of String)

public:
static Task<String^>^ NewAsync(
	CredentialOptions^ credentialOptions, 
	String^ filename, 
	String^ records, 
	NewOptions^ newOptions = nullptr, 
	FunctionsJSON_FORMAT jsonFormat = FunctionsJSON_FORMAT::JSON, 
	String^ customVars = L"", 
	int receiveTimeout = 0
)

static member NewAsync : 
        credentialOptions : CredentialOptions * 
        filename : string * 
        records : string * 
        ?newOptions : NewOptions * 
        ?jsonFormat : FunctionsJSON_FORMAT * 
        ?customVars : string * 
        ?receiveTimeout : int 
(* Defaults:
        let _newOptions = defaultArg newOptions null
        let _jsonFormat = defaultArg jsonFormat FunctionsJSON_FORMAT.JSON
        let _customVars = defaultArg customVars ""
        let _receiveTimeout = defaultArg receiveTimeout 0
*)
-> Task<string>

Parameters

credentialOptions CredentialOptions: Object with data necessary to access the Linkar Server: Username, Password, EntryPoint, Language, FreeText.
filename String: The file name where the records are going to be created.
records String: Buffer of records to write. Inside this string are the recordIds, and the records.
newOptions NewOptions (Optional): Object with write options for the new record(s), including recordIdType, readAfter, calculated, dictionaries, conversion, formatSpec, originalRecords.
jsonFormat FunctionsJSON_FORMAT (Optional): Enum JSON_FORMAT specifies the desired output format: standard JSON, JSON_DICT format, or JSON_SCH format
customVars String (Optional): Free text sent to the database allows management of additional behaviours in SUB.LK.MAIN.CONTROL.CUSTOM, which is called when this parameter is set.
receiveTimeout Int32 (Optional): Maximum time in seconds that the client will wait for a response from the server. Default = 0 to wait indefinitely.

Return Value

TaskString
The results of the operation.

Remarks

Inside the records argument, the records always must be specified. But the recordIds only must be specified when NewOptions argument is null, or when the RecordIdType argument of the NewOptions constructor is null.

Example

C++

Copy

using Linkar;
using Linkar.Functions.Direct.JSON;

class Test
    {
        public string MyNew()
        {
            string result = "";
            try
            {
                CredentialOptions credentials = new CredentialOptions("127.0.0.1", "EPNAME", 11300, "admin", "admin");

                result = Functions.NewAsync(credentials, "LK.CUSTOMERS",
                    "{" +
                    "  \"RECORDS\": [" +
                    "    {" +
                    "      \"LKITEMID\": \"2\"," +
                    "      \"NAME": \"CUSTOMER 2\"," +
                    "      \"ADDR": \"ADDRESS 2\"," +
                    "      \"PHONE": \"444\"" +
                    "    }" +
                    "  ]" +
                    "}").Result;
            }
            catch (Exception ex)
            {
                string error = ex.Message;
                // Do something
            }
            return result;
        }
    }

Imports Linkar
Imports Linkar.Functions.Direct.JSON

Class Test

    Public Function MyNew() As String
        Dim result As String = ""

        Try
            Dim credentials As CredentialOptions = New CredentialOptions("127.0.0.1", "EPNAME", 11300, "admin", "admin")

            result = Functions.NewAsync(credentials, "LK.CUSTOMERS",
                    "{" +
                    "  \"RECORDS\": [" +
                    "    {" +
                    "      \"LKITEMID\": \"2\"," +
                    "      \"NAME": \"CUSTOMER 2\"," +
                    "      \"ADDR": \"ADDRESS 2\"," +
                    "      \"PHONE": \"444\"" +
                    "    }" +
                    "  ]" +
                    "}").Result
        Catch ex As Exception

            Dim[error] As String = ex.Message
            ' Do something
        End Try

        Return result
  End Function
End Class

Reference

Functions Class

Linkar.Functions.Direct.JSON Namespace