Skip to content

Commit 140de68

Browse files
committed
Extend api to support updateRecordings introduced in BBB v1.1
1 parent 41fbc58 commit 140de68

1 file changed

Lines changed: 25 additions & 1 deletion

File tree

lib/bigbluebutton_api.rb

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ class BigBlueButtonApi
6868
# secret:: Shared secret for this server
6969
# version:: API version e.g. 0.81
7070
def initialize(url, secret, version=nil, debug=false)
71-
@supported_versions = ['0.8', '0.81', '0.9', '1.0']
71+
@supported_versions = ['0.8', '0.81', '0.9', '1.0', '1.1']
7272
@url = url
7373
@secret = secret
7474
@debug = debug
@@ -468,6 +468,30 @@ def get_recordings(options={})
468468
response
469469
end
470470

471+
# Available since BBB v1.1
472+
# Update metadata (or other attributes depending on the API implementation) for a given recordID (or set of record IDs).
473+
# recordIDs (string, Array):: ID or IDs of the target recordings.
474+
# Any of the following values are accepted:
475+
# "id1"
476+
# "id1,id2,id3"
477+
# ["id1"]
478+
# ["id1", "id2", "id3"]
479+
# meta (String):: Pass one or more metadata values to be update (format is the same as in create call)
480+
# options (Hash):: Hash with additional parameters. This method doesn't accept additional
481+
# parameters, but if you have a custom API with more parameters, you
482+
# can simply pass them in this hash and they will be added to the API call.
483+
#
484+
# === Example responses
485+
#
486+
# { :returncode => success, :updated => true }
487+
#
488+
def update_recordings(recordIDs, meta=nil, options={})
489+
recordIDs = recordIDs.join(",") if recordIDs.instance_of?(Array) # ["id1", "id2"] becomes "id1,id2"
490+
params = { :recordID => recordIDs, :meta => meta }.merge(options)
491+
send_api_request(:updateRecordings, params)
492+
end
493+
494+
471495
# Publish and unpublish recordings for a given recordID (or set of record IDs).
472496
# recordIDs (string, Array):: ID or IDs of the target recordings.
473497
# Any of the following values are accepted:

0 commit comments

Comments
 (0)