Module: jiveutil

Members

<static> iterator :*

Type:

• *

Source:

• jive-sdk-api/lib/util/jiveutil.js, line 699

<static> oauth :*

Type:

• *

Source:

• jive-sdk-api/lib/util/jiveutil.js, line 694

<static> request :module:jiveRequest

Useful request related utilities

Type:

• module:jiveRequest

Source:

• jive-sdk-api/lib/util/jiveutil.js, line 106

Methods

<static> base64Decode(str) → {*|string}

Parameters:

Name	Type	Description
str

Source:

• jive-sdk-api/lib/util/jiveutil.js, line 464

Returns:

Type

* | string

<static> base64Encode(object) → {*|string}

Parameters:

Name	Type	Description
object

Source:

• jive-sdk-api/lib/util/jiveutil.js, line 456

Returns:

Type

* | string

<static> basicAuthorizationHeaderValid(auth, clientId, clientSecret, authRequired) → {boolean}

Parameters:

Name	Type	Description
auth
clientId
clientSecret
authRequired

Source:

• jive-sdk-api/lib/util/jiveutil.js, line 475

Returns:

Type

boolean

<static> buildRequest(url, method, postBody, headers, requestOptions) → {Promise}

By default this will build a request of type 'application/json'. Set a Content-Type header explicitly if its supposed to be a different type.

Parameters:

Name	Type	Description
url	String
method	String
postBody	Object	leave null unless PUT or POST
headers	Object	leave null or empty [] if no additional headers
requestOptions	Object	leave null or empty [] if no additional request optinos

Source:

• jive-sdk-api/lib/util/jiveutil.js, line 98

Returns:

Promise

Type

Promise

<static> fscopy(source, target) → {Promise}

Parameters:

Name	Type	Description
source
target

Source:

• jive-sdk-api/lib/util/jiveutil.js, line 145

Returns:

Promise

Type

Promise

<static> fsexists(path) → {Promise}

Parameters:

Name	Type	Description
path

Source:

• jive-sdk-api/lib/util/jiveutil.js, line 130

Returns:

Promise

Type

Promise

<static> fsGetSize(filename) → {Promise}

Gets the file size in bytes.

Parameters:

Name	Type	Description
filename		the path to the file.

Source:

• jive-sdk-api/lib/util/jiveutil.js, line 113

Returns:

Promise

Type

Promise

<static> fsisdir(path) → {Promise}

Parameters:

Name	Type	Description
path

Source:

• jive-sdk-api/lib/util/jiveutil.js, line 357

Returns:

Promise

Type

Promise

<static> fsmkdir(path) → {Promise}

Parameters:

Name	Type	Description
path

Source:

• jive-sdk-api/lib/util/jiveutil.js, line 208

Returns:

Promise

Type

Promise

<static> fsread(path) → {Promise}

Parameters:

Name	Type	Description
path

Source:

• jive-sdk-api/lib/util/jiveutil.js, line 228

Returns:

Promise

Type

Promise

<static> fsreaddir(path) → {Promise}

Parameters:

Name	Type	Description
path

Source:

• jive-sdk-api/lib/util/jiveutil.js, line 251

Returns:

Promise

Type

Promise

<static> fsreadJson(path) → {Promise}

Parameters:

Name	Type	Description
path

Source:

• jive-sdk-api/lib/util/jiveutil.js, line 241

Returns:

Promise

Type

Promise

<static> fsrename(source, target, force) → {Promise}

Parameters:

Name	Type	Description
source
target
force

Source:

• jive-sdk-api/lib/util/jiveutil.js, line 183

Returns:

Promise

Type

Promise

<static> fsrmdir(path) → {Promise}

Parameters:

Name	Type	Description
path

Source:

• jive-sdk-api/lib/util/jiveutil.js, line 339

Returns:

Promise

Type

Promise

<static> fsTemplateCopy(source, target, substitutions) → {Promise}

Parameters:

Name	Type	Description
source
target
substitutions

Source:

• jive-sdk-api/lib/util/jiveutil.js, line 407

Returns:

Promise

Type

Promise

<static> fsTemplateRead(source, substitutions) → {Promise}

Parameters:

Name	Type	Description
source
substitutions

Source:

• jive-sdk-api/lib/util/jiveutil.js, line 445

Returns:

Promise

Type

Promise

<static> fsTemplateWrite(data, target, substitutions) → {Promise}

Parameters:

Name	Type	Description
data
target
substitutions

Source:

• jive-sdk-api/lib/util/jiveutil.js, line 428

Returns:

Promise

Type

Promise

<static> fswrite(data, path) → {Promise}

Parameters:

Name	Type	Description
data
path

Source:

• jive-sdk-api/lib/util/jiveutil.js, line 377

Returns:

Promise

Type

Promise

<static> guid() → {String}

Useful general utility functions.

Source:

• jive-sdk-api/lib/util/jiveutil.js, line 60

Returns:

guid

Type

String

<static> jiveAuthorizationHeaderValid(auth, clientId, clientSecret, authRequired) → {boolean}

Parameters:

Name	Type	Description
auth
clientId
clientSecret
authRequired

Source:

• jive-sdk-api/lib/util/jiveutil.js, line 503

Returns:

Type

boolean

<static> recursiveCopy(root, target, force, substitutions, file) → {Promise}

Parameters:

Name	Type	Description
root
target
force
substitutions
file

Source:

• jive-sdk-api/lib/util/jiveutil.js, line 630

Returns:

Promise

Type

Promise

<static> recursiveDirectoryProcessor(currentFsItem, root, targetRoot, force, processor) → {Promise}

Parameters:

Name	Type	Description
currentFsItem
root
targetRoot
force
processor

Source:

• jive-sdk-api/lib/util/jiveutil.js, line 567

Returns:

Promise

Type

Promise

<static> sortObject(o) → {Object}

Parameters:

Name	Type	Description
o

Source:

• jive-sdk-api/lib/util/jiveutil.js, line 541

Returns:

Type

Object

<static> zipFolder(root, targetZip, flatten) → {Promise}

Parameters:

Name	Type	Description
root
targetZip
flatten

Source:

• jive-sdk-api/lib/util/jiveutil.js, line 656

Returns:

Promise

Type

Promise