## RoomNightCustomer RoomNightCustomer **Kind**: global class * [RoomNightCustomer](#RoomNightCustomer) * [.ipfsBase58ToHex(ipfs)](#RoomNightCustomer+ipfsBase58ToHex) ⇒ String * [.ipfsHexToBase58(ipfs)](#RoomNightCustomer+ipfsHexToBase58) ⇒ String * [._getTokenContractInstance(token)](#RoomNightCustomer+_getTokenContractInstance) ⇒ Promise * [.name()](#RoomNightCustomer+name) ⇒ Promise * [.symbol()](#RoomNightCustomer+symbol) ⇒ Promise * [.tokenURI(tokenId)](#RoomNightCustomer+tokenURI) ⇒ Promise * [.balanceOf(owner)](#RoomNightCustomer+balanceOf) ⇒ Promise * [.ownerOf(tokenId)](#RoomNightCustomer+ownerOf) ⇒ Promise * [.getApproved(tokenId)](#RoomNightCustomer+getApproved) ⇒ Promise * [.isApprovedForAll(owner, operator)](#RoomNightCustomer+isApprovedForAll) ⇒ Promise * [.isRefundApplied(rnid)](#RoomNightCustomer+isRefundApplied) ⇒ Promise * [.roomNight(rnid)](#RoomNightCustomer+roomNight) ⇒ Promise * [.roomNightsOfOwner(from, limit, isVendor, options)](#RoomNightCustomer+roomNightsOfOwner) ⇒ Promise * [.safeTransferFrom(from, to, tokenId, data, {tx:)](#RoomNightCustomer+safeTransferFrom) * [.transferFrom(from, to, tokenId, {tx:)](#RoomNightCustomer+transferFrom) * [.transferFromInBatch(from, to, tokenIds, {tx:)](#RoomNightCustomer+transferFromInBatch) * [.approve(approved, tokenId, {tx:)](#RoomNightCustomer+approve) * [.setApprovalForAll(operator, approved, {tx:)](#RoomNightCustomer+setApprovalForAll) * [.buyInBatch(vendorId, rpid, dates, token, options, {tx:)](#RoomNightCustomer+buyInBatch) * [.applyRefund(rnid, isRefund, options, {tx:)](#RoomNightCustomer+applyRefund) * [.refund(rnid, options, {tx:)](#RoomNightCustomer+refund) ### roomNightCustomer.ipfsBase58ToHex(ipfs) ⇒ String Convert IPFS address from base58 to hex format(begin with 0x) **Kind**: instance method of [RoomNightCustomer](#RoomNightCustomer) **Returns**: String - IPFS with hex format(begin with 0x) | Param | Type | Description | | --- | --- | --- | | ipfs | String | IPFS address with base58 encoded | ### roomNightCustomer.ipfsHexToBase58(ipfs) ⇒ String Conver IPFS address from hex format to base58 format **Kind**: instance method of [RoomNightCustomer](#RoomNightCustomer) **Returns**: String - IPFS with base58 format | Param | Type | Description | | --- | --- | --- | | ipfs | String | IPFS address with hex format | ### roomNightCustomer.\_getTokenContractInstance(token) ⇒ Promise **Kind**: instance method of [RoomNightCustomer](#RoomNightCustomer) **Returns**: Promise - {Contract instance} | Param | Type | | --- | --- | | token | token | ### roomNightCustomer.name() ⇒ Promise The name of current room night token **Kind**: instance method of [RoomNightCustomer](#RoomNightCustomer) **Returns**: Promise - {String} The name of current room night token ### roomNightCustomer.symbol() ⇒ Promise The symbol of current room night token **Kind**: instance method of [RoomNightCustomer](#RoomNightCustomer) **Returns**: Promise - {String} The symbol of current room night token ### roomNightCustomer.tokenURI(tokenId) ⇒ Promise The URI of token's information **Kind**: instance method of [RoomNightCustomer](#RoomNightCustomer) **Returns**: Promise - {String} The URI of token. E.g: http://ipfs.tripiochina.cn/api/v0/cat/Qmaj8UWNjTzBMBHkkaqSiyax2nFgiwYP2ewxnhGBucn6S8 | Param | Type | Description | | --- | --- | --- | | tokenId | Number | Token id | ### roomNightCustomer.balanceOf(owner) ⇒ Promise The balance of any address **Kind**: instance method of [RoomNightCustomer](#RoomNightCustomer) **Returns**: Promise - {BigNumber} The token balance | Param | Type | Description | | --- | --- | --- | | owner | String | The owner address of some token | ### roomNightCustomer.ownerOf(tokenId) ⇒ Promise Get the owner of any token **Kind**: instance method of [RoomNightCustomer](#RoomNightCustomer) **Returns**: Promise - {String} The token's owner address | Param | Type | Description | | --- | --- | --- | | tokenId | Number | The room night token id | ### roomNightCustomer.getApproved(tokenId) ⇒ Promise Get the approved address for a single room night token **Kind**: instance method of [RoomNightCustomer](#RoomNightCustomer) **Returns**: Promise - {String} The approved address for this token, or the zero address if there is none | Param | Type | Description | | --- | --- | --- | | tokenId | Number | The room night token id | ### roomNightCustomer.isApprovedForAll(owner, operator) ⇒ Promise Query if an address is an authorized operator for another address **Kind**: instance method of [RoomNightCustomer](#RoomNightCustomer) **Returns**: Promise - {Boolean} True if operator is an approved `operator` for `owner`, false otherwise | Param | Type | Description | | --- | --- | --- | | owner | String | The address that owns the token | | operator | String | The address that acts on behalf of the owner | ### roomNightCustomer.isRefundApplied(rnid) ⇒ Promise Whether the token is in refund applications **Kind**: instance method of [RoomNightCustomer](#RoomNightCustomer) **Returns**: Promise - {Boolean} True if token in refund applications, false otherwise | Param | Type | Description | | --- | --- | --- | | rnid | Number | The room night token id | ### roomNightCustomer.roomNight(rnid) ⇒ Promise Get the room night infomation in detail **Kind**: instance method of [RoomNightCustomer](#RoomNightCustomer) **Returns**: Promise - {vendorId: BigNumber, rateplanId: BigNumber, tokenId: BigNumber, price: BigNumber, timestamp: BigNumber, date: BigNumber, ipfs: Hex String, rateplanName: String} * vendorId: Vendor id * rateplanId: Rateplan id * tokenId: ERC2.0 Token id * price: ERC2.0 price of RP * timestamp: Create time: UTC timestamp(s) * date: Order date E.g: 20180621 * ipfs: The IPFS's address of rateplan's desc(Hex String) * rateplanName: Rateplan name | Param | Type | Description | | --- | --- | --- | | rnid | Number | The room night token id | ### roomNightCustomer.roomNightsOfOwner(from, limit, isVendor, options) ⇒ Promise Get all the room nights of the msg.sender(Customer or Vendor) **Kind**: instance method of [RoomNightCustomer](#RoomNightCustomer) **Returns**: Promise - {roomnightIds: BigNumber|Array, nextId: BigNumber} * roomnightIds: Room night token ids * nextId: The next id of token, if id = 0 the next token is null | Param | Type | Description | | --- | --- | --- | | from | Number | The begin id, if id = 0 search from the begin | | limit | Number | The limit of one page | | isVendor | Boolean | Is vendor or not | | options | Dict | {from: msg.sender} | ### roomNightCustomer.safeTransferFrom(from, to, tokenId, data, {tx:) Transfers the ownership of an room night token from one address to another address. When transfer is complete, this function checks if _to is a smart contract (code size > 0). If so, it calls onERC721Received on _to and throws if the return value is not bytes4(keccak256("onERC721Received(address,uint256,bytes)")). **Kind**: instance method of [RoomNightCustomer](#RoomNightCustomer) | Param | Type | Description | | --- | --- | --- | | from | String | The current owner of the room night token | | to | String | The new owner | | tokenId | Number | The token to transfer | | data | String | Additional data with no specified format, sent in call to `to` | | {tx: | Promise | String, from: BigNumber, to: BigNumber, tokenId: BigNumber} * tx: Transaction number * from: The current owner of the room night token * to: The new owner * tokenId: The token to transfer | ### roomNightCustomer.transferFrom(from, to, tokenId, {tx:) Transfers the ownership of an room night token from one address to another address **Kind**: instance method of [RoomNightCustomer](#RoomNightCustomer) | Param | Type | Description | | --- | --- | --- | | from | String | The current owner of the room night token | | to | String | The new owner | | tokenId | Number | The token to transfer | | {tx: | Promise | String, from: BigNumber, to: BigNumber, tokenId: BigNumber} * tx: Transaction number * from: The current owner of the room night token * to: The new owner * tokenId: The token to transfer | ### roomNightCustomer.transferFromInBatch(from, to, tokenIds, {tx:) Transfers the ownership of tokens from one address to another address **Kind**: instance method of [RoomNightCustomer](#RoomNightCustomer) | Param | Type | Description | | --- | --- | --- | | from | String | The current owner of the room night token | | to | String | The new owner | | tokenIds | Number \| Array | The tokens to transfer | | {tx: | Promise | String, from: BigNumber, to: BigNumber, tokenIds: Number|Array} * tx: Transaction number * from: The current owner of the room night token * to: The new owner * tokenIds: The token to transfer | ### roomNightCustomer.approve(approved, tokenId, {tx:) Set or reaffirm the approved address for an room night token **Kind**: instance method of [RoomNightCustomer](#RoomNightCustomer) | Param | Type | Description | | --- | --- | --- | | approved | String | The new approved token controller | | tokenId | Number | The token to approve | | {tx: | Promise | String, owner: String, approved: String, tokenId: BigNumber} * tx: Transaction number * owner: The current owner of the room night token * approved: The new approved token controller * tokenId: The token to approve | ### roomNightCustomer.setApprovalForAll(operator, approved, {tx:) Enable or disable approval for a third party ("operator") to manage all of msg.sender's assets **Kind**: instance method of [RoomNightCustomer](#RoomNightCustomer) | Param | Type | Description | | --- | --- | --- | | operator | String | The new approved token controller | | approved | Boolean | The token to approve | | {tx: | Promise | String, owner: String, operator: String, approved: Boolean} * tx: Transaction number * owner: The current owner of the room night token * operator: The new approved token controller * approved: The token to approve | ### roomNightCustomer.buyInBatch(vendorId, rpid, dates, token, options, {tx:) By room nigth in batch through ETH(`token` == 0) or other digital token(`token` != 0) **Kind**: instance method of [RoomNightCustomer](#RoomNightCustomer) | Param | Type | Description | | --- | --- | --- | | vendorId | Number | The vendor Id | | rpid | Number | The vendor's rate plan id | | dates | Number \| Array | The booking dates | | token | Number | The digital currency token | | options | Dict | {from: msg.sender} | | {tx: | Promise | String, customer: String, vendor: String, rpid: BigNumber, dates: Number|Array, token: BigNumber} * tx: Transaction number * customer: The customer address * vendor: Then vendor address * rpid: The rateplan id * dates: The booking dates * token: The digital currency token | ### roomNightCustomer.applyRefund(rnid, isRefund, options, {tx:) Apply room night refund **Kind**: instance method of [RoomNightCustomer](#RoomNightCustomer) | Param | Type | Description | | --- | --- | --- | | rnid | Number | Room night token id | | isRefund | Boolean | if true the `rnid` can refund else not | | options | Dict | {from: msg.sender} | | {tx: | Promise | String, customer: String, rnid: BigNumber, isRefund: Boolean} * tx: Transaction number * customer: The customer address * rnid: The rateplan id * isRefund: if true the `rnid` can refund else not | ### roomNightCustomer.refund(rnid, options, {tx:) Refund through ETH or other digital token, give the room night ETH/TOKEN to customer and take back inventory **Kind**: instance method of [RoomNightCustomer](#RoomNightCustomer) | Param | Type | Description | | --- | --- | --- | | rnid | Number | Room night token id | | options | Dict | {from: msg.sender} | | {tx: | Promise | String, vendor: String, rnid: BigNumber} * tx: Transaction number * vendor: Then vendor address * rnid: Room night token id |