ym.core.Request
Overview
The main request object for managing Web service requests.
Initialization
Constructor(jsonpAlias, forceCredentialsByParams)
- Parameters
-
jsonpAlias
- Description: An alias prefix for JSONP requests.
- Data type: string
-
forceCredentialsByParams
- Description: Sends the credentials in the HTTP header for authentication, if desired. Note that this feature is not fully supported by all browsers.
- Data type: bool
- Default value:
false
Methods
deprecated(component, link, expirationDate) ab v3
Writes a message in the developer tool that informs about an obsolete component.
- Parameters
-
component
- Description: The component that is marked as obsolete.
- Data type: function
-
link
- Description: The link to the documentation of the new or changed component.
- Data type: string
-
expirationDate
- Description: The date on which the component is removed.
- Data type: date
emit(eventName, arguments) ab v3
Triggers an event.
- Parameters
-
eventName
- Data type: string
-
arguments
- Data type: *
-
Return:
ym.core.EventEmitter
error(args) ab v3
Writes an error message in the developer tool.
- Parameters
- args
- Description: Writes a notification in the developer tool.
info(args) ab v3
Writes a message in the developer tool.
- Parameters
- args
- Description: Several arguments and data types are possible.
log(args) ab v3
Makes a log entry in the developer tool.
- Parameters
- args
- Description: Several arguments and data types are possible.
notify(msg) ab v3
Writes a notification in the developer tool.
- Parameters
- msg
- Description: Notification
- Data type: string
off(eventName, handler) ab v3
Removes an event listener.
- Parameters
-
eventName
- Data type: string
-
handler
- Data type: function
-
Return:
ym.core.EventEmitter
on(eventName, handler) ab v3
Adds a listener.
- Parameters
-
eventName
- Data type: string
-
handler
- Data type: function
-
Return:
ym.core.EventEmitter
once(eventName, handler) ab v3
Adds a listener that reacts only to a single event.
- Parameters
-
eventName
- Data type: string
-
handler
- Data type: function
-
Return:
ym.core.EventEmitter
warn(args) ab v3
Writes a warning in the developer tool.
- Parameters
- args
- Description: Several arguments and data types are possible.