Skip to content

Adding section to quickstart on binding methods to extend sdk #89

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Oct 26, 2019
Merged

Adding section to quickstart on binding methods to extend sdk #89

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
54b156b
added bind methods section to quickstart
Oct 21, 2019
fd1053a
formatting
Oct 21, 2019
569ce6d
spelling and phrasing of binding methods
Oct 21, 2019
a269b9f
added to binding methods section
Oct 21, 2019
10e566c
fixed up bound method example
Oct 21, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions docs/user/quickstart.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -468,6 +468,25 @@ contain all of the returned objects.
>>> rooms_list = list(rooms_iterable)



Extending the API with bound methods
------------------------------------

As the Webex Teams API is developed and features are added, it may be necessary to extend the webexteamssdk to access those features.
Extending the API is simple by binding your own methods to the WebexTeamsAPI connection object. By binding a method, you can
extend functionality and leverage all of the objects and quality of life features of webexteamssdk.

.. code-block:: python

>>> new_method(self, param):
... json_obj = self._session.get('/example/action/' + param)
... return json_obj

>>> api = WebexTeamsAPI()
>>> api.new_method = new_method
>>> output = WebexTeamsAPI.new_method(param)


*Copyright (c) 2016-2019 Cisco and/or its affiliates.*


Expand Down