Codeunit "ForNAV DirPrt API"
Methods
ApiVersion
Get the version of the API
procedure ApiVersion(): Integer
Returns
Type | Description |
---|---|
Integer |
Remarks
Version 3
JobCount
Get the number of jobs in the queue
procedure JobCount(): Integer
Returns
Type | Description |
---|---|
Integer |
Remarks
Version 1
GetSettings
Get next available print job for a specific service.
procedure GetSettings(serviceKey: Text, serviceName: Text): Text
Parameters
Name | Type | Description |
---|---|---|
serviceKey | Text |
Security key. |
serviceName | Text |
Name of service asking for a print job. |
Returns
Type | Description |
---|---|
Text |
Base64 encoded print job. |
Remarks
Version 2
GetJob
Obsolete
This element will become obsolete from version Old API. Not used since direct print service 6.2.0.2215
Get next available print job for a specific service.
[Obsolete(Not used since direct print service 6.2.0.2215,Old API)]
procedure GetJob(serviceKey: Text, serviceName: Text): Text
Parameters
Name | Type | Description |
---|---|---|
serviceKey | Text |
Security key. |
serviceName | Text |
Name of service asking for a print job. |
Returns
Type | Description |
---|---|
Text |
Base64 encoded print job. |
Remarks
Version 1
GetJob2
procedure GetJob2(serviceKey: Text, serviceName: Text, waitSeconds: Decimal): Text
Parameters
Name | Type | Description |
---|---|---|
serviceKey | Text | |
serviceName | Text | |
waitSeconds | Decimal |
Returns
Type | Description |
---|---|
Text |
GetJob3
Get next available print job for a specific service.
procedure GetJob3(serviceKey: Text, serviceName: Text, waitSeconds: Decimal, instanceNo: Integer): Text
Parameters
Name | Type | Description |
---|---|---|
serviceKey | Text |
Security key. |
serviceName | Text |
Name of service asking for a print job. |
waitSeconds | Decimal |
Duration of long poll. |
instanceNo | Integer |
Security key. |
Returns
Type | Description |
---|---|
Text |
Base64 encoded print job. |
Remarks
Version 2
SetStatus
Set the status of a print job
procedure SetStatus(serviceKey: Text, id: Integer, status: Text, serviceName: Text, message: Text): Text
Parameters
Name | Type | Description |
---|---|---|
serviceKey | Text |
Security key. |
id | Integer |
id of the print job |
status | Text |
New status for the print job |
serviceName | Text |
Name of service setting the status |
message | Text |
Security key. |
Returns
Type | Description |
---|---|
Text |
Remarks
Version 1
SetStatus2
procedure SetStatus2(serviceKey: Text, id: Integer, status: Text, serviceName: Text, message: Text, response: Text): Text
Parameters
Name | Type | Description |
---|---|---|
serviceKey | Text | |
id | Integer | |
status | Text | |
serviceName | Text | |
message | Text | |
response | Text |
Returns
Type | Description |
---|---|
Text |
UpdatePrinters
Update the the printer list and paper source information for a service
procedure UpdatePrinters(serviceKey: Text, serviceName: Text, json: Text): Text
Parameters
Name | Type | Description |
---|---|---|
serviceKey | Text |
Security key. |
serviceName | Text |
Name of service |
json | Text |
JSON data containing the printer list and paper sources. |
Returns
Type | Description |
---|---|
Text |
Remarks
Version 1
GetJobInternal
Obsolete
This element will become obsolete from version Internal function moved. Not Needed
[Obsolete(Not Needed,Internal function moved)]
[TryFunction]
procedure GetJobInternal(serviceKey: Text, serviceName: Text, var retv: Text): Boolean
Parameters
Name | Type | Description |
---|---|---|
serviceKey | Text | |
serviceName | Text | |
retv | Text |
Returns
Type | Description |
---|---|
Boolean |
HasLocalPrinter
Obsolete
This element will become obsolete from version Internal function moved. Not Needed
[Obsolete(Not Needed,Internal function moved)]
procedure HasLocalPrinter(serviceName: Text, localPrinterName: Text): Boolean
Parameters
Name | Type | Description |
---|---|---|
serviceName | Text | |
localPrinterName | Text |
Returns
Type | Description |
---|---|
Boolean |
SetStatusInternal
Obsolete
This element will become obsolete from version Internal function moved. Not Needed
[Obsolete(Not Needed,Internal function moved)]
[TryFunction]
procedure SetStatusInternal(serviceKey: Text, id: Integer, status: Text, serviceName: Text, message: Text): Boolean
Parameters
Name | Type | Description |
---|---|---|
serviceKey | Text | |
id | Integer | |
status | Text | |
serviceName | Text | |
message | Text |
Returns
Type | Description |
---|---|
Boolean |
UpdatePrintersInternal
Obsolete
This element will become obsolete from version Internal function moved. Not Needed
[Obsolete(Not Needed,Internal function moved)]
[TryFunction]
procedure UpdatePrintersInternal(serviceKey: Text, serviceName: Text, json: Text): Boolean
Parameters
Name | Type | Description |
---|---|---|
serviceKey | Text | |
serviceName | Text | |
json | Text |
Returns
Type | Description |
---|---|
Boolean |
ValidateKey
Obsolete
This element will become obsolete from version Internal function moved. Not Needed
[Obsolete(Not Needed,Internal function moved)]
procedure ValidateKey(serviceKey: Text)
Parameters
Name | Type | Description |
---|---|---|
serviceKey | Text |