YammerClient
Attributes
module-attribute
TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'OnNewMessagesFollowingV2': {'operation_id': 'OnNewMessagesFollowingV2', 'path': '/{connectionId}/v2/trigger/messages/following.json', 'method': 'get', 'required_parameters': [], 'callback_payload_type': 'MessageList'}, 'OnNewMessagesInGroupV2': {'operation_id': 'OnNewMessagesInGroupV2', 'path': '/{connectionId}/v2/trigger/in_group/{group_id}.json', 'method': 'get', 'required_parameters': ['group_id'], 'callback_payload_type': 'MessageList'}}
Classes
dataclass
Response for Get my networks
Attributes
class-attribute
instance-attribute
Unique identifier of the network.
class-attribute
instance-attribute
Summary of the network.
dataclass
YammerEntity(*, type_: Optional[str] = None, id: Optional[int] = None, full_name: Optional[str] = None)
Response for Get groups
Attributes
class-attribute
instance-attribute
Details of the Viva Engage entity.
class-attribute
instance-attribute
Unique identifier of the group.
dataclass
User(*, name: Optional[str] = None, job_title: Optional[str] = None, location: Optional[str] = None, full_name: Optional[str] = None, first_name: Optional[str] = None, last_name: Optional[str] = None, web_url: Optional[str] = None, email: Optional[str] = None, birth_date: Optional[str] = None, mugshot_url: Optional[str] = None)
Response for Get user details
Attributes
class-attribute
instance-attribute
Username.
class-attribute
instance-attribute
User job title.
class-attribute
instance-attribute
User location.
class-attribute
instance-attribute
User full name.
class-attribute
instance-attribute
User first name.
class-attribute
instance-attribute
User last name.
class-attribute
instance-attribute
User profile url.
class-attribute
instance-attribute
User email.
class-attribute
instance-attribute
User birth date.
dataclass
dataclass
dataclass
Message(*, id: Optional[int] = None, content_excerpt: Optional[str] = None, sender_id: Optional[int] = None, replied_to_id: Optional[int] = None, created_at: Optional[str] = None, network_id: Optional[int] = None, message_type: Optional[str] = None, sender_type: Optional[str] = None, url: Optional[str] = None, web_url: Optional[str] = None, group_id: Optional[int] = None, body: Optional[MessageBody | Mapping[str, Any]] = None, thread_id: Optional[int] = None, direct_message: Optional[bool] = None, client_type: Optional[str] = None, client_url: Optional[str] = None, language: Optional[str] = None, notified_user_ids: Optional[List[int]] = None, privacy: Optional[str] = None, liked_by: Optional[LikedBy | Mapping[str, Any]] = None, system_message: Optional[bool] = None)
Definition: Message
Attributes
class-attribute
instance-attribute
ID associated with the post.
class-attribute
instance-attribute
Text Content of the post.
class-attribute
instance-attribute
Unique ID of user who posted the message.
class-attribute
instance-attribute
ID of the message to which this message is a reply.
class-attribute
instance-attribute
Time at which the message was created.
class-attribute
instance-attribute
Id of the network message is associated with.
class-attribute
instance-attribute
Description of the message type.
class-attribute
instance-attribute
Description of the type of sender.
class-attribute
instance-attribute
API url of the post.
class-attribute
instance-attribute
Web url of the post.
class-attribute
instance-attribute
Unique ID of group who posted the message.
class-attribute
instance-attribute
Unique ID of thread.
class-attribute
instance-attribute
Flag to specify if the post is a a direct message.
class-attribute
instance-attribute
Type of the client.
class-attribute
instance-attribute
Web link of the client.
class-attribute
instance-attribute
Language used in the message.
class-attribute
instance-attribute
Details of users notified.
class-attribute
instance-attribute
Details of the privacy associated with the message.
dataclass
dataclass
PostOperationRequest(group_id: int, body: str, *, replied_to_id: Optional[int] = None, direct_to_id: Optional[int] = None, broadcast: Optional[bool] = None, title: Optional[str] = None)
Definition: PostOperationRequest
Attributes
class-attribute
instance-attribute
The message ID this message is in reply to.
class-attribute
instance-attribute
If set, a private message will be sent directly to the user with the indicated ID.
class-attribute
instance-attribute
Post message as an announcement to all users in a group.
dataclass
MessageBody(*, parsed: Optional[str] = None, plain: Optional[str] = None, rich: Optional[str] = None)
Definition: MessageBody
Attributes
class-attribute
instance-attribute
Parsed text format.
class-attribute
instance-attribute
Plain text format.
dataclass
Definition: LikedBy
Attributes
class-attribute
instance-attribute
Number of distinct likes.
YammerClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)
Bases: ConnectorClientBase
Typed client for yammer connector.
Initialize a YammerClient.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
connection_runtime_url
|
str
|
The connection runtime URL from Azure Portal. |
required |
credential
|
AsyncTokenCredential | AzureKeyCredential
|
Caller-owned Azure Core credential. |
required |
max_retry_attempts
|
int
|
The maximum number of request attempts. |
3
|
timeout
|
float
|
The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. |
30.0
|
use_exponential_backoff
|
bool
|
Whether retries use exponential backoff. |
True
|
initial_retry_delay_seconds
|
float
|
The initial retry delay in seconds. |
0.5
|
maximum_retry_delay_seconds
|
float
|
The maximum retry delay in seconds. |
120.0
|
retry_jitter_factor
|
float
|
The jitter fraction applied to retry delays. |
0.1
|
retry_unsafe_http_methods
|
bool
|
Whether unsafe HTTP methods may be retried. |
False
|
transport
|
Optional[AsyncHttpTransport]
|
Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle. |
None
|
**kwargs
|
Any
|
Optional Azure Core pipeline policy settings. |
{}
|
Methods:
list_networks(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get my networks
Gets all the networks that the user belongs to.
Returns a single-page Azure Core async collection.
Swagger operation ID: GetNetworks.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_groups(*, network_id: Optional[str] = None, mine: Optional[int] = None, show_all_company_group: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get groups
Gets all groups. If mine = 1, get only groups to which the user belongs
Returns a single-page Azure Core async collection.
Swagger operation ID: GetGroups.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
network_id
|
Optional[str]
|
Network ID. |
None
|
mine
|
Optional[int]
|
Used for getting groups which user is part of. |
None
|
show_all_company_group
|
Optional[int]
|
Used for showing All Company Group. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
get_user_details_by_id(user_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get user details
This operation returns user profile details.
Swagger operation ID: GetUserDetailsById.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
user_id
|
int
|
Unique identifier of the user. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
like_message(message_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Like message
This operation is used to like the specified message.
Swagger operation ID: LikeMessage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
message_id
|
str
|
Unique id of the message. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_all_messages(*, network_id: Optional[str] = None, older_than: Optional[int] = None, newer_than: Optional[int] = None, threaded: Optional[str] = None, limit: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get all messages
This operation returns all public messages in the logged in user's Viva Engage network. Corresponds to "All" conversations in the Viva Engage web interface.
Returns an Azure Core async pager that follows the connector continuation URL.
Swagger operation ID: GetAllMessagesV3.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
network_id
|
Optional[str]
|
Network ID. |
None
|
older_than
|
Optional[int]
|
Returns messages older than the message ID specified as a numeric string. This is useful for paginating messages. For example, if you're currently viewing 20 messages and the oldest is number 2912, you could append "?older_than=2912″ to your request to get the 20 messages prior to those you're seeing. |
None
|
newer_than
|
Optional[int]
|
Returns messages newer than the message ID specified as a numeric string. This should be used when polling for new messages. If you're looking at messages, and the most recent message returned is 3516, you can make a request with the parameter "?newer_than=3516″ to ensure that you do not get duplicate copies of messages already on your page. |
None
|
threaded
|
Optional[str]
|
Threaded=true will only return the thread starter (first message) for each thread. This parameter is intended for apps which need to display message threads collapsed. threaded=extended will return the thread starter messages and the two most recent messages all ordered by activity, as they are viewed in the default view on the Viva Engage web interface. |
None
|
limit
|
Optional[int]
|
Return only the specified number of messages. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_messages_following(*, network_id: Optional[str] = None, older_than: Optional[int] = None, newer_than: Optional[int] = None, threaded: Optional[str] = None, limit: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get the messages from my Following feed
This operation returns the messages from Following feed which is conversations involving people, groups and topics that the user is following.
Returns an Azure Core async pager that follows the connector continuation URL.
Swagger operation ID: GetMessagesFollowingV3.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
network_id
|
Optional[str]
|
Unique identifier of the network. |
None
|
older_than
|
Optional[int]
|
Returns messages older than the message ID specified as a numeric string. This is useful for paginating messages. For example, if you're currently viewing 20 messages and the oldest is number 2912, you could append "?older_than=2912″ to your request to get the 20 messages prior to those you're seeing. |
None
|
newer_than
|
Optional[int]
|
Returns messages newer than the message ID specified as a numeric string. This should be used when polling for new messages. If you're looking at messages, and the most recent message returned is 3516, you can make a request with the parameter "?newer_than=3516″ to ensure that you do not get duplicate copies of messages already on your page. |
None
|
threaded
|
Optional[str]
|
Threaded=true will only return the thread starter (first message) for each thread. This parameter is intended for apps which need to display message threads collapsed. threaded=extended will return the thread starter messages and the two most recent messages all ordered by activity, as they are viewed in the default view on the Viva Engage web interface. |
None
|
limit
|
Optional[int]
|
Return only the specified number of messages. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_messages_in_group(group_id: int, *, network_id: Optional[str] = None, older_than: Optional[int] = None, newer_than: Optional[int] = None, threaded: Optional[str] = None, limit: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get messages in a group
This operation returns the messages posted in a group.
Returns an Azure Core async pager that follows the connector continuation URL.
Swagger operation ID: GetMessagesInGroupV3.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
group_id
|
int
|
Unique identifier of the group. |
required |
network_id
|
Optional[str]
|
Unique identifier of the network. |
None
|
older_than
|
Optional[int]
|
Returns messages in threads where the thread's latest message is older than the specified message ID. Any thread with a most recent message ID that is newer than or equal to the specified ID will not have any of its messages returned by this query. |
None
|
newer_than
|
Optional[int]
|
Returns messages in threads where the thread's latest message is newer than the specified message ID. Any thread with a most recent message ID that is older than or equal to the specified ID will not have any of its messages returned by this query. |
None
|
threaded
|
Optional[str]
|
Threaded=true will only return the thread starter (first message) for each thread. This parameter is intended for apps which need to display message threads collapsed. threaded=extended will return the thread starter messages and the two most recent messages all ordered by activity, as they are viewed in the default view on the Viva Engage web interface. |
None
|
limit
|
Optional[int]
|
Return only the specified number of messages. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_messages_in_thread(thread_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get messages in a thread
This operation returns the messages posted in a thread.
Returns an Azure Core async pager that follows the connector continuation URL.
Swagger operation ID: GetMessagesInThreadV3.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
thread_id
|
int
|
Unique identifier of the thread. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
post_message(input: PostOperationRequest | Mapping[str, Any], *, network_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Post message
This operation is used to post a Message to a Group or All Company Feed. If group ID is provided, message will be posted to the specified group else it will be posted in All Company Feed.
Swagger operation ID: PostMessageV2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PostOperationRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
network_id
|
Optional[str]
|
Unique id of the network. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |