CosNotific...rtiesAdmin(3)

✨ CosNotification_AdminPropertiesAdmin ✨

okay so bestie, welcome to the Erlang module definition for CosNotification_AdminPropertiesAdmin — yes that name is a whole mouthful, i know, but stay with me 🫶 this is an Erlang module page from the cosNotification docs and it's genuinely not that deep once we get into it.

---

💖 NAME 💖

CosNotification_AdminPropertiesAdmin — this module implements the OMG CosNotification::AdminPropertiesAdmin interface. that's it, that's the whole vibe, it's the admin-properties plug for your notification service 🎀

---

🌸 DESCRIPTION 🌸

so like, if you wanna get access to the record definitions for the structures, you do this:

-include_lib("cosNotification/include/*.hrl").

literally just drop that include in and you're golden ✨

Also, every object that inherits this interface exports the functions described in this module. no cap, all of them 👑

---

🌈 EXPORTS 🌈

💅 get_admin(Object) -> AdminProperties

Types:

Object = #objref
AdminProperties = [AdminProperty]
AdminProperty = #'CosNotification_Property'{name, value}
name = string()
value = #any

This operation hands you back a sequence of name-value pairs that encapsulates the current administrative properties of the target object. it's giving "receipts, please" — you ask, it tells you exactly what its admin settings are right now 💖

---

💅 set_admin(Object, AdminProperties) -> Reply

Types:

Object = #objref
AdminProperties = [AdminProperty]
AdminProperty = #'CosNotification_Property'{name, value}
name = string()
value = #any
Reply = ok | {'EXCEPTION', CosNotification_UnsupportedAdmin}

As input, this operation accepts a sequence of name-value pairs encapsulating the desired administrative settings for the target object. so you're like, "here's what i want you to be now" and it goes and does it 🪄

but bestie listen — if it is not possible to set the given properties, the exception UnsupportedAdmin will be raised. so handle that {'EXCEPTION', CosNotification_UnsupportedAdmin} reply, don't just assume ok, fr fr 😭

---

🌟 the cute sign-off 🌟

that's the whole page, periodt 💅 this little icon came to you from Ericsson AB, part of the cosNotification docs, version 5.2.2, and yes we're still on that CosNotific...rtiesAdmin(3) manual-page energy. go forth and admin your properties, you main character 👑🦋