MediaWiki master
IApiMessage.php
Go to the documentation of this file.
1<?php
7namespace MediaWiki\Api;
8
10
29interface IApiMessage extends MessageSpecifier {
39 public function getApiCode();
40
45 public function getApiData();
46
52 public function setApiCode( $code, ?array $data = null );
53
57 public function setApiData( array $data );
58}
59
61class_alias( IApiMessage::class, 'IApiMessage' );
Interface for messages with machine-readable data for use by the API.
getApiData()
Returns additional machine-readable data about the error condition.
setApiData(array $data)
Sets additional machine-readable data about the error condition.
setApiCode( $code, ?array $data=null)
Sets the machine-readable code for use by the API.
getApiCode()
Returns a machine-readable code for use by the API.