Interaction

Definition

[h2]qg.showToast(Object object)

• Description

  Displays a toast.

• Parameters in object

  Parameter	Type	Default Value	Mandatory	Description
  title	string	-	No	Toast title. Either title or message must be set. If this parameter is not passed, the value of message will be displayed.
  icon	string	'success'	No	Icon to be displayed. The options are as follows: success: success icon. The title text can contain up to 14 characters. loading: loading icon. The title text can contain up to 14 characters. none: No icon is displayed. The title text can contain up to two lines.
  image	string	-	No	Custom icon path. The priority of image is higher than that of icon.
  message(1078+)	string	-	No	Toast content. Either title or message must be set, and the value of title is displayed preferentially.
  duration	number	0 or 1500	No	Duration for displaying the toast. If title is left empty and message is set, the options of duration are 0 (short) and 1 (long). The default value is 0. If title has a value, the default value is 1500 milliseconds.
  mask	boolean	-	No	Indicates whether to display the clear mask. true: The touch event is blocked. When the pop-up is displayed, other controls in the game cannot be tapped. false (default value): The touch event is not blocked, and other controls in the game can be tapped.
  success	function	-	No	Callback function triggered upon a successful API call.
  fail	function	-	No	Callback function triggered upon a failed API call.
  complete	function	-	No	If a function is passed, it will be called regardless of whether the API call succeeds or fails.

• Sample code

  qg.showToast({
      title: 'Success',
      icon: 'success',
      duration: 2000
  })

[h2]qg.showModal(Object object)

• Description

  Displays a modal.

• Parameters in object

  Parameter	Type	Default Value	Mandatory	Description
  title	string	-	No	Modal title.
  content	string	-	No	Modal content.
  showCancel	boolean	true	No	Indicates whether to display a cancel button.
  cancelText	string	Cancel	No	Text on the cancel button. The value contains up to four characters.
  cancelColor	string	#576B95	No	Color of the text on the cancel button. The value must be a hexadecimal character string that specifies a color.
  confirmText	string	OK	No	Text on the confirm button. The value contains up to four characters.
  confirmColor	string	#576B95	No	Color of the text on the confirm button. The value must be a hexadecimal character string that specifies a color.
  success	function	-	No	Callback function triggered upon a successful API call. For details, please refer to Parameters in the success callback function.
  fail	function	-	No	Callback function triggered upon a failed API call.
  complete	function	-	No	If a function is passed, it will be called regardless of whether the API call succeeds or fails.

  • Parameters in the success callback function

    Parameter	Type	Description
    confirm (1078+)	boolean	The value true indicates that the user taps the confirm button.
    cancel (1078+)	boolean	The value true indicates that the user taps the cancel button.

• Sample code

  qg.showModal({
      title: 'Tips',
      content: 'This is a modal.',
      success (res) {
          if (res.confirm) {
              console.log('The user taps OK.')
          } else if (res.cancel) {
               console.log('The user taps Cancel.')
          }
      }
  })

[h2]qg.showLoading(Object object)

• Description

  Displays a loading pop-up. The pop-up can be closed only after qg.hideLoading is called.

• Parameters in object

  Parameter	Type	Default Value	Mandatory	Description
  title	string	-	Yes	Pop-up content.
  mask	boolean	false	No	Indicates whether to display the clear mask. Set this parameter to true to block touch events.
  success	function	-	No	Callback function triggered upon a successful API call. For details, please refer to Parameters in the success callback function.
  fail	function	-	No	Callback function triggered upon a failed API call.
  complete	function	-	No	If a function is passed, it will be called regardless of whether the API call succeeds or fails.

  • Parameters in the success callback function

    Parameter	Type	Description
    cancel	boolean	Indicates whether the user chooses to close the loading pop-up. If the value is true, the loading pop-up is not displayed when the user taps the back button.

• Sample code

  qg.showLoading({
      title: 'Loading',
  })
  setTimeout(function () {
      qg.hideLoading()
  }, 2000)

[h2]qg.showActionSheet(Object object)

• Description

  Displays the operation menu.

• Parameters in object

  Parameter	Type	Default Value	Mandatory	Description
  itemList	array string	-	Yes	Array of button text labels, with a maximum length of six items.
  itemColor	string	#000000	No	Button color.
  success	function	-	No	Callback function triggered upon a successful API call. For details, please refer to Parameters in the success callback function.
  fail	function	-	No	Callback function triggered upon a failed API call.
  complete	function	-	No	If a function is passed, it will be called regardless of whether the API call succeeds or fails.

  • Parameters in the success callback function

    Parameter	Type	Description
    tapIndex	number	Index of an item in the itemList array, which indicates the sequence number of the button tapped by a user, counted from top to bottom starting at 0.

• Sample code

  qg.showActionSheet({
      itemList: ['A', 'B', 'C'],
      success (res) {
          console.log(res)
      },
      fail (res) {
          console.log(res.errMsg)
      }
  })

[h2]qg.hideToast(Object object)

• Description

  Hides a toast.

• Parameters in object

  Parameter	Type	Default Value	Mandatory	Description
  success	function	-	No	Callback function triggered upon a successful API call.
  fail	function	-	No	Callback function triggered upon a failed API call.
  complete	function	-	No	If a function is passed, it will be called regardless of whether the API call succeeds or fails.

• Sample code

  qg.hideToast ({
      success (res) {
          console.log('success')
      },
      fail (res) {
          console.log('fail')
      }
  })

[h2]qg.hideLoading(Object object)

• Description

  Hides a loading pop-up.

• Parameters in object

  Parameter	Type	Default Value	Mandatory	Description
  success	function	-	No	Callback function triggered upon a successful API call.
  fail	function	-	No	Callback function triggered upon a failed API call.
  complete	function	-	No	If a function is passed, it will be called regardless of whether the API call succeeds or fails.

• Sample code

  qg.hideLoading ({
      success (res) {
          console.log('success')
      },
      fail (res) {
          console.log('fail')
      }
  })