Namespace: common

Methods

getActiveItems(items){Array}

common/item.js, line 163

getActiveItems

Name	Type	Description
items	Array

getAvailableItems(items){Array}

common/item.js, line 149

getAvailableItems

Name	Type	Description
items	Array

getAvatarInitial(name, size){string}

common/image.js, line 6

Returns an avatar image with the initials of the user source: http://codepen.io/leecrossley/pen/CBHca

Name	Type	Description
name	string	name for which to display the initials
size	string	Possible values XS,S,M,L,XL

Returns:

image url

getCategoryKeyFromName(name){string}

common/keyValues.js, line 10

Creates a category key from a friendly name

Name	Type	Description
name	string

getCategoryNameFromKey(key){string}

common/keyValues.js, line 23

Creates a name from a category key

Name	Type	Description
key	string

getCategorySummary(items){string}

common/keyValues.js, line 37

getCategorySummary

Name	Type	Description
items	array

getCheqRoomRedirectUrl(codeId){string}

common/code.js, line 127

getCheqRoomRedirectUrl

Name	Type	Description
codeId

getCheqRoomRedirectUrlQR(codeId, size){string}

common/code.js, line 140

getCheqRoomRedirectUrlQR

Name	Type	Description
codeId
size

getCheqRoomRedirectUrlQR(urlApi, code, size){string}

common/code.js, line 160

getQRCodeUrl

Name	Type	Description
urlApi	string
code	string
size	number

getCheqRoomRedirectUrlQR(urlApi, code, size){string}

common/code.js, line 175

getBarcodeUrl

Name	Type	Description
urlApi	string
code	string
size	number

getContactImageCDNUrl(){string}

common/contact.js, line 70

getContactImageCDNUrl

Name	Type	Description
cr.Contact		or contact object

Returns:

path or base64 image

getContactImageUrl(){string}

common/contact.js, line 49

getContactImageUrl

Name	Type	Description
cr.Contact		or contact object

Returns:

path or base64 image

getDocumentIds(docs){array}

common/document.js, line 66

getDocumentIds

Name	Type	Description
docs

getFileNameFromUrl(url){string}

common/attachment.js, line 42

getFileNameFromUrl

Name	Type	Description
url

getFriendlyConflictKind(kind){string}

common/conflicts.js, line 6

getFriendlyConflictKind

Name	Type	Description
kind

getFriendlyItemStatus(status){string}

common/item.js, line 48

getFriendlyItemStatus

Name	Type	Description
status

getFriendlyKitStatus(status){string}

common/kit.js, line 112

getFriendlyKitStatus

Name	Type	Description
status

getFriendlyOrderCss(status){string}

common/order.js, line 25

getFriendlyOrderCss

Name	Type	Description
status	string

getFriendlyOrderDuration(transaction, dateHelper){string}

common/transaction.js, line 53

getFriendlyOrderDuration Gets a friendly duration for a given order

Name	Type	Description
transaction
dateHelper

getFriendlyOrderSize(order){string}

common/order.js, line 43

getFriendlyOrderSize

Name	Type	Description
order	object

getFriendlyOrderStatus(status){string}

common/order.js, line 6

getFriendlyOrderStatus

Name	Type	Description
status	string

getFriendlyReservationCss(status){string}

common/reservation.js, line 6

getFriendlyReservationCss

Name	Type	Description
status	string

getFriendlyReservationDuration(transaction, dateHelper){string}

common/transaction.js, line 91

getFriendlyReservationDuration Gets a friendly duration for a given reservation

Name	Type	Description
transaction
dateHelper

getFriendlyReservationFrequency(frequency){string}

common/reservation.js, line 44

getFriendlyReservationFrequency

Name	Type	Description
frequency	string

getFriendlyReservationStatus(status){string}

common/reservation.js, line 25

getFriendlyReservationStatus

Name	Type	Description
status	string

getFriendlyTemplateCss(status){string}

common/template.js, line 44

getFriendlyTemplateCss

Name	Type	Description
status	string

getFriendlyTemplateSize(width, height, unit){string}

common/template.js, line 62

getFriendlyTemplateSize

Name	Type	Description
width	float
height	float
unit	string

getFriendlyTemplateStatus(status){string}

common/template.js, line 26

getFriendlyTemplateStatus

Name	Type	Description
status	string

getIconAvatar(size){string}

common/image.js, line 78

Returns an icon avatar image from FontAwesome collection

Name	Type	Description
size	string	Possible values XS,S,M,L,XL

Returns:

image url

getImageCDNUrl(settings, groupId, attachmentId, size){string}

common/image.js, line 194

getImageCDNUrl

Name	Type	Description
settings
groupId
attachmentId
size

getImageUrl(ds, pk, size, bustCache){string}

common/image.js, line 170

getImageUrl

Name	Type	Description
ds
pk
size
bustCache

getImgFileNameFromName(name){string}

common/attachment.js, line 10

getImgFileNameFromName

Name	Type	Description
name

getItemIds(items){array}

common/item.js, line 179

getItemIds

Name	Type	Description
items

getItemsByStatus(items, comparator){Array}

common/item.js, line 124

getItemsByStatus

Name	Type	Description
items	Array
comparator	string | function

getItemStatusCss(status){string}

common/item.js, line 74

getItemStatusCss

Name	Type	Description
status

getItemStatusIcon(status){string}

common/item.js, line 99

getItemStatusIcon

Name	Type	Description
status

getItemSummary(items){string}

common/keyValues.js, line 93

getItemSummary

Works much like getCategorySummary but prefers making summaries with kit names in it

Name	Type	Description
items	array

getKitIds(items){array}

common/kit.js, line 148

getKitIds

Name	Type	Description
items

getKitStatus(status){string}

common/kit.js, line 67

getKitStatus Available => if all items in the kit are available Checking out => if all item in the kit is checking out Checked out => if all item in the kit is checked out Expired => if all item in the kit is expired Unknown => if not all items in the kit have the same status

Name	Type	Description
status

getKitStatusCss(status){string}

common/kit.js, line 130

getKitStatusCss

Name	Type	Description
status

getMaintenanceAvatar(size){string}

common/image.js, line 65

Returns an maintenace avatar image

Name	Type	Description
size	string	Possible values XS,S,M,L,XL

Returns:

image url

getOrderCss(order, now){string}

common/order.js, line 114

getOrderCss

Name	Type	Description
order	object
now	moment

getOrderDuration(){duration}

common/transaction.js, line 33

getOrderDuration Gets a moment duration object

getOrderStatus(order, now){string}

common/order.js, line 93

getOrderStatus

Name	Type	Description
order	object
now	moment

getReservationCss(reservation){string}

common/reservation.js, line 111

getReservationCss

Name	Type	Description
reservation	object

getReservationDuration(transaction){duration}

common/transaction.js, line 70

getReservationDuration Return a Moment duration for a given reservation

Name	Type	Description
transaction

getTransactionSummary(transaction, emptyText){string}

common/transaction.js, line 8

getTransactionSummary Return a friendly summary for a given transaction or custom name

Name	Type	Description
transaction	object
emptyText	string

getUserImageCDNUrl(){string}

common/user.js, line 23

getUserImageCDNUrl

Name	Type	Description
cr.User		or user object

Returns:

path or base64 image

getUserImageUrl(){string}

common/user.js, line 6

getUserImageUrl

Name	Type	Description
cr.User		or user object

Returns:

path or base64 image

isCodeFromScanner(urlPart){Boolean}

common/code.js, line 21

isCodeFromScanner

Name	Type	Description
urlPart

isCodeValid(codeId){Boolean}

common/code.js, line 6

isCodeValid

Name	Type	Description
codeId

isFreeEmail(email){boolean}

common/validation.js, line 18

isFreeEmail

Name	Type	Description
email

isNumeric(value, onlyInteger){Boolean}

common/validation.js, line 72

isNumeric https://stackoverflow.com/questions/18082/validate-decimal-numbers-in-javascript-isnumeric

Name	Type	Description
value	string
onlyInteger	boolean

isOrderArchived(order){Boolean}

common/order.js, line 80

isOrderArchived

Name	Type	Description
order	object

isOrderOverdue(order, now){Boolean}

common/order.js, line 65

isOrderOverdue

Name	Type	Description
order	object
now	moment

isReservationArchived(reservation){Boolean}

common/reservation.js, line 98

isReservationArchived

Name	Type	Description
reservation	object

isReservationInThePast(reservation, now){Boolean}

common/reservation.js, line 83

isReservationInThePast

Name	Type	Description
reservation	object
now	moment

isReservationOverdue(reservation, now){Boolean}

common/reservation.js, line 68

isReservationOverdue

Name	Type	Description
reservation	object
now	moment

isValidBarcode(barCode){Boolean}

common/code.js, line 40

isBarcodeValid

Name	Type	Description
barCode	string

isValidDate(value){Boolean}

common/validation.js, line 91

isValidDate

Name	Type	Description
value	string

isValidDocQRCode(qrCode){Boolean}

common/code.js, line 84

isValidDocQRCode For example: http://cheqroom.com/qr/eeaa37ed

Name	Type	Description
qrCode	string

isValidEmail(email){Boolean}

common/validation.js, line 6

isValidEmail

Name	Type	Description
email	string

isValidItemQRCode(qrCode){Boolean}

common/code.js, line 99

isValidItemQRCode

Name	Type	Description
qrCode	string

isValidKitQRCode(qrCode){Boolean}

common/code.js, line 113

isValidKitQRCode

Name	Type	Description
qrCode	string

isValidPassword(password){boolean}

common/validation.js, line 60

isValidPassword

Name	Type	Description
password

isValidPhone(phone){Boolean}

common/validation.js, line 30

isValidPhone

Name	Type	Description
phone	string

isValidQRCode(qrCode){Boolean}

common/code.js, line 54

isValidQRCode

Name	Type	Description
qrCode	string

isValidTransferQRCode(qrCode){Boolean}

common/code.js, line 69

isValidTransferQRCode For example: http://cheqroom.com/ordertransfer/tTfZXW6eTianQU3UQVELdn

Name	Type	Description
qrCode	string

isValidURL(url){boolean}

common/validation.js, line 47

isValidURL

Name	Type	Description
url	string

kitCanCheckout(kit){boolean}

common/kit.js, line 7

Checks if a kit can be checked out (any items available)

Name	Type	Description
kit

kitCanReleaseCustody(kit){boolean}

common/kit.js, line 43

Checks if custody can be released for a kit (based on status)

Name	Type	Description
kit

kitCanReserve(kit){boolean}

common/kit.js, line 19

Checks if a kit can be reserved (any items active)

Name	Type	Description
kit

kitCanTakeCustody(kit){boolean}

common/kit.js, line 31

Checks if custody can be taken for a kit (based on status)

Name	Type	Description
kit

kitCanTransferCustody(kit){boolean}

common/kit.js, line 55

Checks if custody can be transferred for a kit (based on status)

Name	Type	Description
kit

makeFileNameJpg(name){string}

common/attachment.js, line 29

makeFileNameJpg

Name	Type	Description
name

searchDocument(doc, value, fields)

common/document.js, line 7

Checks if a given object (document) contains given value

Name	Type	Description
doc
value
fields