mediatype.update
Opis
object mediatype.update(object/array mediaTypes)
Ta metoda umożliwia aktualizowanie istniejących typów mediów.
Ta metoda jest dostępna tylko dla użytkowników typu Super admin. Uprawnienia do wywoływania tej metody można odebrać w ustawieniach roli użytkownika. Więcej informacji można znaleźć w sekcji Role użytkowników.
Parametry
(object/array) Właściwości typu mediów do zaktualizowania.
Właściwość mediatypeid musi być zdefiniowana dla każdego typu mediów, wszystkie
pozostałe właściwości są opcjonalne. Zaktualizowane zostaną tylko przekazane
właściwości, wszystkie pozostałe pozostaną bez zmian.
Oprócz standardowych właściwości typu mediów, metoda akceptuje następujące parametry.
| Parametr | Typ | Opis |
|---|---|---|
| message_templates | array | Szablony wiadomości zastępujące bieżące szablony wiadomości. |
Zwracane wartości
(object) Zwraca obiekt zawierający identyfikatory zaktualizowanych typów mediów we właściwości mediatypeids.
Przykłady
Włączanie typu mediów
Włącz typ mediów, czyli ustaw jego status na "0".
{
"jsonrpc": "2.0",
"method": "mediatype.update",
"params": {
"mediatypeid": "6",
"status": "0"
},
"id": 1
}
Odpowiedź:
{
"jsonrpc": "2.0",
"result": {
"mediatypeids": [
"6"
]
},
"id": 1
}
Źródło
CMediaType::update() w ui/include/classes/api/services/CMediaType.php.