JSAPI

Since 9.1

removeNotifyListener

Remove listener from listening native notification event.

Usage

AlipayJSBridge.call('removeNotifyListener', {
  name: 'fortest'
}, function (result) {
  console.log(result);
});

Example

Basic Function

<h1>Please click on the buttons below</h1>
<p>Although the following test is conducted in one page, you can use this API to listen to events happens in other pages</p>

<a href="#" class="btn start">Start Listening</a>
<a href="#" class="btn stop">Stop Listening</a>
<a href="#" class="btn send">Notify</a>

<script>
function callback(e){
  alert(JSON.stringify(e));
};

function ready(callback) {
  // Invoke directly if JSBridge is already injected
  if (window.AlipayJSBridge) {
    callback && callback();
  } else {
    // Otherwise listen to `AlipayJSBridgeReady` event
    document.addEventListener('AlipayJSBridgeReady', callback, false);
  }
}
ready(function(){
  document.querySelector('.start').addEventListener('click', function() {
    AlipayJSBridge.call('addNotifyListener', {
      name:'NEBULANOTIFY_TEST_EVENT' // H5 event name must be prefixed with NEBULANOTIFY_
    }, callback);
  });

  document.querySelector('.stop').addEventListener('click', function() {
    AlipayJSBridge.call('removeNotifyListener', {
      name:'NEBULANOTIFY_TEST_EVENT' // H5 event name must be prefixed with NEBULANOTIFY_
    }, function(e) {
      alert(JSON.stringify(e));
    });
  });

  document.querySelector('.send').addEventListener('click', function() {
    AlipayJSBridge.call('postNotification', {
      name:'NEBULANOTIFY_TEST_EVENT', // H5 event name must be prefixed with NEBULANOTIFY_
      data: {
        hello: 'world'
      }
    });
  });
});
</script>

API

AlipayJSBridge.call('removeNotifyListener', {
  name
}, fn)

Input Parameters

NameTypeDescriptionMandatoryDefault
namestringName of eventY
fnfunctionCallback functionN

Output Parameters

Parameter result:{} that passed to the callback function

NameTypeDescription
successboolTrue if the removal is successful

Error

errorDescription
4No permission

Remarks

  • No matter whether the listener is registered or not, the removal call always returns success:true.