Class: MicrosoftGraph::Teams::Item::Channels::Item::Messages::MessagesRequestBuilder

Inherits:
MicrosoftKiotaAbstractions::BaseRequestBuilder
  • Object
show all
Defined in:
lib/teams/item/channels/item/messages/messages_request_builder.rb

Overview

Provides operations to manage the messages property of the microsoft.graph.channel entity.

Defined Under Namespace

Classes: MessagesRequestBuilderGetQueryParameters

Instance Method Summary collapse

Constructor Details

#initialize(path_parameters, request_adapter) ⇒ Object

Instantiates a new MessagesRequestBuilder and sets the default values.

Parameters:

  • path_parameters

    Path parameters for the request

  • request_adapter

    The request adapter to use to execute the requests.



52
53
54
# File 'lib/teams/item/channels/item/messages/messages_request_builder.rb', line 52

def initialize(path_parameters, request_adapter)
    super(path_parameters, request_adapter, "{+baseurl}/teams/{team%2Did}/channels/{channel%2Did}/messages{?%24top,%24skip,%24search,%24filter,%24count,%24orderby,%24select,%24expand}")
end

Instance Method Details

#by_chat_message_id(chat_message_id) ⇒ Object

Provides operations to manage the messages property of the microsoft.graph.channel entity.

Parameters:

  • chat_message_id

    The unique identifier of chatMessage

Returns:

  • a chat_message_item_request_builder

Raises:

  • (StandardError)


40
41
42
43
44
45
# File 'lib/teams/item/channels/item/messages/messages_request_builder.rb', line 40

def by_chat_message_id(chat_message_id)
    raise StandardError, 'chat_message_id cannot be null' if chat_message_id.nil?
    url_tpl_params = @path_parameters.clone
    url_tpl_params["chatMessage%2Did"] = chat_message_id
    return MicrosoftGraph::Teams::Item::Channels::Item::Messages::Item::ChatMessageItemRequestBuilder.new(url_tpl_params, @request_adapter)
end

#countObject

Provides operations to count the resources in the collection.



27
28
29
# File 'lib/teams/item/channels/item/messages/messages_request_builder.rb', line 27

def count()
    return MicrosoftGraph::Teams::Item::Channels::Item::Messages::Count::CountRequestBuilder.new(@path_parameters, @request_adapter)
end

#deltaObject

Provides operations to call the delta method.



32
33
34
# File 'lib/teams/item/channels/item/messages/messages_request_builder.rb', line 32

def delta()
    return MicrosoftGraph::Teams::Item::Channels::Item::Messages::Delta::DeltaRequestBuilder.new(@path_parameters, @request_adapter)
end

#get(request_configuration = nil) ⇒ Object

Retrieve the list of messages (without the replies) in a channel of a team. To get the replies for a message, call the list message replies or the get message reply API. This method supports federation. To list channel messages in application context, the request must be made from the tenant that the channel owner belongs to (represented by the tenantId property on the channel).

Parameters:

  • request_configuration (defaults to: nil)

    Configuration for the request such as headers, query parameters, and middleware options.

Returns:

  • a Fiber of chat_message_collection_response



60
61
62
63
64
65
66
67
68
# File 'lib/teams/item/channels/item/messages/messages_request_builder.rb', line 60

def get(request_configuration=nil)
    request_info = self.to_get_request_information(
        request_configuration
    )
    error_mapping = Hash.new
    error_mapping["4XX"] = lambda {|pn| MicrosoftGraph::Models::ODataErrorsODataError.create_from_discriminator_value(pn) }
    error_mapping["5XX"] = lambda {|pn| MicrosoftGraph::Models::ODataErrorsODataError.create_from_discriminator_value(pn) }
    return @request_adapter.send_async(request_info, lambda {|pn| MicrosoftGraph::Models::ChatMessageCollectionResponse.create_from_discriminator_value(pn) }, error_mapping)
end

#post(body, request_configuration = nil) ⇒ Object

Send a new chatMessage in the specified channel.

Parameters:

  • body

    The request body

  • request_configuration (defaults to: nil)

    Configuration for the request such as headers, query parameters, and middleware options.

Returns:

  • a Fiber of chat_message

Raises:

  • (StandardError)


75
76
77
78
79
80
81
82
83
84
# File 'lib/teams/item/channels/item/messages/messages_request_builder.rb', line 75

def post(body, request_configuration=nil)
    raise StandardError, 'body cannot be null' if body.nil?
    request_info = self.to_post_request_information(
        body, request_configuration
    )
    error_mapping = Hash.new
    error_mapping["4XX"] = lambda {|pn| MicrosoftGraph::Models::ODataErrorsODataError.create_from_discriminator_value(pn) }
    error_mapping["5XX"] = lambda {|pn| MicrosoftGraph::Models::ODataErrorsODataError.create_from_discriminator_value(pn) }
    return @request_adapter.send_async(request_info, lambda {|pn| MicrosoftGraph::Models::ChatMessage.create_from_discriminator_value(pn) }, error_mapping)
end

#to_get_request_information(request_configuration = nil) ⇒ Object

Retrieve the list of messages (without the replies) in a channel of a team. To get the replies for a message, call the list message replies or the get message reply API. This method supports federation. To list channel messages in application context, the request must be made from the tenant that the channel owner belongs to (represented by the tenantId property on the channel).

Parameters:

  • request_configuration (defaults to: nil)

    Configuration for the request such as headers, query parameters, and middleware options.

Returns:

  • a request_information



90
91
92
93
94
95
96
97
98
99
100
101
102
# File 'lib/teams/item/channels/item/messages/messages_request_builder.rb', line 90

def to_get_request_information(request_configuration=nil)
    request_info = MicrosoftKiotaAbstractions::RequestInformation.new()
    request_info.url_template = @url_template
    request_info.path_parameters = @path_parameters
    request_info.http_method = :GET
    request_info.headers.add('Accept', 'application/json')
    unless request_configuration.nil?
        request_info.add_headers_from_raw_object(request_configuration.headers)
        request_info.set_query_string_parameters_from_raw_object(request_configuration.query_parameters)
        request_info.add_request_options(request_configuration.options)
    end
    return request_info
end

#to_post_request_information(body, request_configuration = nil) ⇒ Object

Send a new chatMessage in the specified channel.

Parameters:

  • body

    The request body

  • request_configuration (defaults to: nil)

    Configuration for the request such as headers, query parameters, and middleware options.

Returns:

  • a request_information

Raises:

  • (StandardError)


109
110
111
112
113
114
115
116
117
118
119
120
121
122
# File 'lib/teams/item/channels/item/messages/messages_request_builder.rb', line 109

def to_post_request_information(body, request_configuration=nil)
    raise StandardError, 'body cannot be null' if body.nil?
    request_info = MicrosoftKiotaAbstractions::RequestInformation.new()
    request_info.url_template = @url_template
    request_info.path_parameters = @path_parameters
    request_info.http_method = :POST
    request_info.headers.add('Accept', 'application/json')
    unless request_configuration.nil?
        request_info.add_headers_from_raw_object(request_configuration.headers)
        request_info.add_request_options(request_configuration.options)
    end
    request_info.set_content_from_parsable(@request_adapter, "application/json", body)
    return request_info
end