Cobbler Frontend Docs
  1. Miscellaneous
  2. Functions

Index

projects/typescript-xmlrpc/src/lib/serializer.ts

appendArray
appendArray(value: XmlRpcArray, xml: XMLBuilder)
Parameters :
Name Type Optional
value XmlRpcArray No
xml XMLBuilder No
Returns : void
appendBoolean
appendBoolean(value: boolean, xml: XMLBuilder)

This method appends to a node a boolean in XMLRPC style. This means that true is converted to 1 and false is converted to 0.

Parameters :
Name Type Optional Description
value boolean No

Either true or false.
xml XMLBuilder No

The parent node the value should be appended to.
Returns : void
appendBuffer
appendBuffer(value: ArrayBuffer, xml: XMLBuilder)
Parameters :
Name Type Optional
value ArrayBuffer No
xml XMLBuilder No
Returns : void
appendDatetime
appendDatetime(value: Date, xml: XMLBuilder)
Parameters :
Name Type Optional
value Date No
xml XMLBuilder No
Returns : void
appendNumber
appendNumber(value: number, xml: XMLBuilder)
Parameters :
Name Type Optional
value number No
xml XMLBuilder No
Returns : void
appendString
appendString(value: string, xml: XMLBuilder)

This method appends to a node a string in XMLRPC style.

Parameters :
Name Type Optional Description
value string No

The string to append. Escaping if needed is done by XMLBuilder2
xml XMLBuilder No

The parent node the value should be appended to.
Returns : void
appendStruct
appendStruct(value: XmlRpcStruct, xml: XMLBuilder)
Parameters :
Name Type Optional
value XmlRpcStruct No
xml XMLBuilder No
Returns : void
arrayBufferToBase64
arrayBufferToBase64(buffer: ArrayBuffer)
Parameters :
Name Type Optional
buffer ArrayBuffer No
serializeMethodCall
serializeMethodCall(method: string, params?: Array, encoding?: string)

Creates the XML for an XML-RPC method call.

Parameters :
Name Type Optional Description
method string No
  • The method name.
params Array Yes
  • Params to pass in the call. If none are needed this parameter can be skipped.
encoding string Yes
  • The encoding which is added to the XML document. If no specific is required just skip it.
Returns : string
serializeValue
serializeValue(value: XmlRpcTypes, xml: XMLBuilder)
Parameters :
Name Type Optional
value XmlRpcTypes No
xml XMLBuilder No
Returns : void

projects/typescript-xmlrpc/src/lib/deserializer.ts

convertArray
convertArray(element: Element)
Parameters :
Name Type Optional
element Element No
Returns : Array<any>
convertDomToObject
convertDomToObject(document: Document)

This method converts any document either in a meaningful response object or throws an error.

Parameters :
Name Type Optional Description
document Document No

The document to convert.
Returns : MethodResponse | MethodFault
convertFault
convertFault(element: Element)
Parameters :
Name Type Optional
element Element No
Returns : MethodFault
convertMember
convertMember(element: Element)
Parameters :
Name Type Optional
element Element No
Returns : Member
convertMethodResponse
convertMethodResponse(document: Document)
Parameters :
Name Type Optional
document Document No
Returns : MethodResponse | MethodFault
convertName
convertName(element: Element)
Parameters :
Name Type Optional
element Element No
Returns : string
convertParam
convertParam(element: Element)
Parameters :
Name Type Optional
element Element No
Returns : Param
convertParams
convertParams(element: Element)
Parameters :
Name Type Optional
element Element No
Returns : Array<Param>
convertStruct
convertStruct(element: Element)
Parameters :
Name Type Optional
element Element No
Returns : Map<string, any>
convertValue
convertValue(element: Element)
Parameters :
Name Type Optional
element Element No
Returns : XmlRpcTypes
deserialize
deserialize(content: string)
Parameters :
Name Type Optional
content string No
Returns : MethodResponse | MethodFault
deserializeResponse
deserializeResponse(content: string)

Deserializes a response of the XMLRPC API into a XML Document

Parameters :
Name Type Optional Description
content string No

The content of XML which is to be parsed.
Returns : Document

results matching ""

    No results matching ""