Skip to content

API Reference Overview ​

The Skyroom wrapper provides two ways to interact with the API:

  1. Fluent Resource Managers: Skyroom::rooms(), Skyroom::users(), Skyroom::services()
  2. Direct Shortcut Methods: Skyroom::getRooms(), Skyroom::createRoom(...), etc.

Both interfaces invoke the exact same underlying logic.


Method Matrix ​

Skyroom ActionResource MethodShortcut MethodDescription
getServicesSkyroom::services()->all()Skyroom::getServices()List all active/purchased services
getRoomsSkyroom::rooms()->all()Skyroom::getRooms()List all created rooms
countRoomsSkyroom::rooms()->count()Skyroom::countRooms()Get total number of rooms
getRoomSkyroom::rooms()->get(...)Skyroom::getRoom(...)Get room by ID or name
getRoomUrlSkyroom::rooms()->url(...)Skyroom::getRoomUrl(...)Get permanent room link
createRoomSkyroom::rooms()->create(...)Skyroom::createRoom(...)Create a new room
updateRoomSkyroom::rooms()->update(...)Skyroom::updateRoom(...)Update room attributes
deleteRoomSkyroom::rooms()->delete(...)Skyroom::deleteRoom(...)Delete a room
getRoomUsersSkyroom::rooms()->users(...)Skyroom::getRoomUsers(...)List users with room access
addRoomUsersSkyroom::rooms()->addUsers(...)Skyroom::addRoomUsers(...)Grant users room access
removeRoomUsersSkyroom::rooms()->removeUsers(...)Skyroom::removeRoomUsers(...)Revoke users room access
updateRoomUserSkyroom::rooms()->updateUser(...)Skyroom::updateRoomUser(...)Update user access level in room
getUsersSkyroom::users()->all()Skyroom::getUsers()List all users
countUsersSkyroom::users()->count()Skyroom::countUsers()Get total user count
getUserSkyroom::users()->get(...)Skyroom::getUser(...)Get user by ID or username
createUserSkyroom::users()->create(...)Skyroom::createUser(...)Create new user account
updateUserSkyroom::users()->update(...)Skyroom::updateUser(...)Update user details
deleteUserSkyroom::users()->delete(...)Skyroom::deleteUser(...)Delete a single user
deleteUsersSkyroom::users()->deleteMany(...)Skyroom::deleteUsers(...)Batch delete users
getUserRoomsSkyroom::users()->rooms(...)Skyroom::getUserRooms(...)List rooms assigned to a user
addUserRoomsSkyroom::users()->addRooms(...)Skyroom::addUserRooms(...)Assign rooms to user
removeUserRoomsSkyroom::users()->removeRooms(...)Skyroom::removeUserRooms(...)Unassign rooms from user
createLoginUrlDirect methodSkyroom::createLoginUrl(...)Generate instant SSO login URL
(Raw action)Skyroom::call($action, $params)Skyroom::call(...)Call any raw/unwrapped action

Released under the MIT License.