C# Класс PodioAPI.Services.ConversationService

Показать файл Открыть проект

Открытые методы

Метод Описание
AddParticipants ( int conversationId, List participants ) : Task

The list of people to grant access to. This is a list of contact identifiers.

Podio API Reference: https://developers.podio.com/doc/conversations/add-participants-v2-37282400

ConversationService ( Podio currentInstance ) : System.Collections.Generic
CreateConversation ( ConversationCreateRequest conversationCreateRequest ) : Task

Creates a new conversation with a list of users. Once a conversation is started, the participants cannot (yet) be changed.

Podio API Reference: https://developers.podio.com/doc/conversations/create-conversation-v2-37301474

CreateConversationOnObject ( string refType, int refId, ConversationCreateRequest conversationCreateRequest ) : Task

Creates a new conversation on the given object. Works similarly to the create notification method in other regards.

Podio API Reference: https://developers.podio.com/doc/conversations/create-conversation-on-object-22442

GetConversation ( int conversationId ) : Task

Gets the conversation including participants and messages with the the given id. Only participants in the conversation is allowed to view the conversation.

Podio API Reference: https://developers.podio.com/doc/conversations/get-conversation-22369

GetConversationEvent ( int eventId ) : Task

Returns data about the given event.

Podio API Reference: https://developers.podio.com/doc/conversations/get-conversations-34822801

GetConversationEvents ( int conversationId, int limit = 10, int offset ) : Task>

Returns the events on the conversation.

Podio API Reference: https://developers.podio.com/doc/conversations/get-conversation-events-35440697

GetConversations ( int limit = 10, int offset ) : Task>

Returns all the users conversations ordered by time of the last event.

Podio API Reference: https://developers.podio.com/doc/conversations/get-conversations-34822801

GetConversationsOnObject ( string refType, int refId ) : Task>

Returns a list of all the conversations on the object that the active user is part of.

Podio API Reference: https://developers.podio.com/doc/conversations/get-conversations-on-object-22443

GetExistingDirectConversation ( int userId ) : Task

Returns the existing direct conversation with the user. If none exists a 404 will be returned.

Podio API Reference: https://developers.podio.com/doc/conversations/get-existing-direct-conversation-44969910

GetFlaggedConversationCounts ( string flag ) : Task

Returns the number of conversations with the given flag. The flag can be one of:unread or starred.

Podio API Reference: https://developers.podio.com/doc/conversations/get-flagged-conversation-counts-35467925

GetFlaggedConversations ( string flag, int limit = 10, int offset ) : Task>

Returns the conversations with the given flag. The flag can be one of:unread or starred

Podio API Reference: https://developers.podio.com/doc/conversations/get-flagged-conversations-35466860

LeaveConversation ( int converstionId ) : Task

Leave the given conversation.

Podio API Reference: https://developers.podio.com/doc/conversations/leave-conversation-35483748

MarkAllConversationsAsRead ( ) : Task

Marks all the users conversations as read.

Podio API Reference: https://developers.podio.com/doc/conversations/mark-conversation-as-read-35441525

MarkConversationAsRead ( int conversationId ) : Task

Mark the conversation as read.

Podio API Reference: https://developers.podio.com/doc/conversations/mark-conversation-as-read-35441525

MarkConversationAsUnread ( int converstionId ) : Task

Mark the conversation as unread.

Podio API Reference: https://developers.podio.com/doc/conversations/mark-conversation-as-unread-35441542

ReplyToConversation ( int converstionId, string text, List fileIds = null, int embedId = null, string embedUrl = null ) : Task

Creates a reply to the conversation. Returns the conversation event this generates.

Podio API Reference: https://developers.podio.com/doc/conversations/reply-to-conversation-v2-37260916

SearchConversations ( string text, int limit = 10, int offset, bool participants = false ) : Task>

Returns the users conversations that match the given text ordered by time of the last event.

Podio API Reference: https://developers.podio.com/doc/conversations/search-conversations-36885550

StarConversation ( int converstionId ) : Task

Star the given conversation. If the conversation is already starred, nothing will happen.

Podio API Reference: https://developers.podio.com/doc/conversations/star-conversation-35106944

UnstarConversation ( int converstionId ) : Task

Removes the star from the conversation.

Podio API Reference: https://developers.podio.com/doc/conversations/unstar-conversation-35106990

Описание методов

AddParticipants() публичный Метод

The list of people to grant access to. This is a list of contact identifiers.

Podio API Reference: https://developers.podio.com/doc/conversations/add-participants-v2-37282400

public AddParticipants ( int conversationId, List participants ) : Task
conversationId int
participants List The list of people to grant access to. This is a list of contact identifiers
Результат Task

ConversationService() публичный Метод

public ConversationService ( Podio currentInstance ) : System.Collections.Generic
currentInstance Podio
Результат System.Collections.Generic

CreateConversation() публичный Метод

Creates a new conversation with a list of users. Once a conversation is started, the participants cannot (yet) be changed.

Podio API Reference: https://developers.podio.com/doc/conversations/create-conversation-v2-37301474

public CreateConversation ( ConversationCreateRequest conversationCreateRequest ) : Task
conversationCreateRequest PodioAPI.Models.Request.ConversationCreateRequest
Результат Task

CreateConversationOnObject() публичный Метод

Creates a new conversation on the given object. Works similarly to the create notification method in other regards.

Podio API Reference: https://developers.podio.com/doc/conversations/create-conversation-on-object-22442

public CreateConversationOnObject ( string refType, int refId, ConversationCreateRequest conversationCreateRequest ) : Task
refType string
refId int
conversationCreateRequest PodioAPI.Models.Request.ConversationCreateRequest
Результат Task

GetConversation() публичный Метод

Gets the conversation including participants and messages with the the given id. Only participants in the conversation is allowed to view the conversation.

Podio API Reference: https://developers.podio.com/doc/conversations/get-conversation-22369

public GetConversation ( int conversationId ) : Task
conversationId int
Результат Task

GetConversationEvent() публичный Метод

Returns data about the given event.

Podio API Reference: https://developers.podio.com/doc/conversations/get-conversations-34822801

public GetConversationEvent ( int eventId ) : Task
eventId int
Результат Task

GetConversationEvents() публичный Метод

Returns the events on the conversation.

Podio API Reference: https://developers.podio.com/doc/conversations/get-conversation-events-35440697

public GetConversationEvents ( int conversationId, int limit = 10, int offset ) : Task>
conversationId int
limit int The maximum number of conversations/events to return. Default value: 10
offset int The offset into the list of conversations/events to return. Default value: 0
Результат Task>

GetConversations() публичный Метод

Returns all the users conversations ordered by time of the last event.

Podio API Reference: https://developers.podio.com/doc/conversations/get-conversations-34822801

public GetConversations ( int limit = 10, int offset ) : Task>
limit int The maximum number of conversations/events to return. Default value: 10
offset int The offset into the list of conversations/events to return. Default value: 0
Результат Task>

GetConversationsOnObject() публичный Метод

Returns a list of all the conversations on the object that the active user is part of.

Podio API Reference: https://developers.podio.com/doc/conversations/get-conversations-on-object-22443

public GetConversationsOnObject ( string refType, int refId ) : Task>
refType string
refId int
Результат Task>

GetExistingDirectConversation() публичный Метод

Returns the existing direct conversation with the user. If none exists a 404 will be returned.

Podio API Reference: https://developers.podio.com/doc/conversations/get-existing-direct-conversation-44969910

public GetExistingDirectConversation ( int userId ) : Task
userId int
Результат Task

GetFlaggedConversationCounts() публичный Метод

Returns the number of conversations with the given flag. The flag can be one of:unread or starred.

Podio API Reference: https://developers.podio.com/doc/conversations/get-flagged-conversation-counts-35467925

public GetFlaggedConversationCounts ( string flag ) : Task
flag string
Результат Task

GetFlaggedConversations() публичный Метод

Returns the conversations with the given flag. The flag can be one of:unread or starred

Podio API Reference: https://developers.podio.com/doc/conversations/get-flagged-conversations-35466860

public GetFlaggedConversations ( string flag, int limit = 10, int offset ) : Task>
flag string
limit int
offset int
Результат Task>

LeaveConversation() публичный Метод

Leave the given conversation.

Podio API Reference: https://developers.podio.com/doc/conversations/leave-conversation-35483748

public LeaveConversation ( int converstionId ) : Task
converstionId int
Результат Task

MarkAllConversationsAsRead() публичный Метод

Marks all the users conversations as read.

Podio API Reference: https://developers.podio.com/doc/conversations/mark-conversation-as-read-35441525

public MarkAllConversationsAsRead ( ) : Task
Результат Task

MarkConversationAsRead() публичный Метод

Mark the conversation as read.

Podio API Reference: https://developers.podio.com/doc/conversations/mark-conversation-as-read-35441525

public MarkConversationAsRead ( int conversationId ) : Task
conversationId int
Результат Task

MarkConversationAsUnread() публичный Метод

Mark the conversation as unread.

Podio API Reference: https://developers.podio.com/doc/conversations/mark-conversation-as-unread-35441542

public MarkConversationAsUnread ( int converstionId ) : Task
converstionId int
Результат Task

ReplyToConversation() публичный Метод

Creates a reply to the conversation. Returns the conversation event this generates.

Podio API Reference: https://developers.podio.com/doc/conversations/reply-to-conversation-v2-37260916

public ReplyToConversation ( int converstionId, string text, List fileIds = null, int embedId = null, string embedUrl = null ) : Task
converstionId int
text string The text of the reply.
fileIds List The list of file ids to be attached to the message.
embedId int /// [OPTIONAL] The id of an embedded link that has been created with the Add an mebed operation in /// the Embed area ///
embedUrl string The url to be attached
Результат Task

SearchConversations() публичный Метод

Returns the users conversations that match the given text ordered by time of the last event.

Podio API Reference: https://developers.podio.com/doc/conversations/search-conversations-36885550

public SearchConversations ( string text, int limit = 10, int offset, bool participants = false ) : Task>
text string
limit int The maximum number of conversations/events to return. Default value: 10
offset int The offset into the list of conversations/events to return. Default value: 0
participants bool /// If true it searches through the conversation participants names/emails. If false it searches /// through the conversation subject and messages. Default value: false ///
Результат Task>

StarConversation() публичный Метод

Star the given conversation. If the conversation is already starred, nothing will happen.

Podio API Reference: https://developers.podio.com/doc/conversations/star-conversation-35106944

public StarConversation ( int converstionId ) : Task
converstionId int
Результат Task

UnstarConversation() публичный Метод

Removes the star from the conversation.

Podio API Reference: https://developers.podio.com/doc/conversations/unstar-conversation-35106990

public UnstarConversation ( int converstionId ) : Task
converstionId int
Результат Task