mirror of
https://github.com/vector-im/element-ios.git
synced 2024-09-29 07:42:40 +00:00
102 lines
2.7 KiB
Objective-C
102 lines
2.7 KiB
Objective-C
/*
|
|
Copyright 2017 Vector Creations Ltd
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
#import "WebViewViewController.h"
|
|
|
|
#import "WidgetManager.h"
|
|
#import "MatrixKit.h"
|
|
|
|
/**
|
|
`WidgetViewController` displays widget within a webview.
|
|
|
|
It also exposes a generic pipe, the postMessage API, to communicate with the
|
|
content within the webview, ie the widget (matrix app).
|
|
*/
|
|
@interface WidgetViewController : WebViewViewController
|
|
|
|
/**
|
|
The displayed widget.
|
|
*/
|
|
@property (nonatomic, readonly) Widget *widget;
|
|
|
|
/**
|
|
The room data source.
|
|
Required if the widget needs to post messages.
|
|
*/
|
|
@property (nonatomic) MXKRoomDataSource *roomDataSource;
|
|
|
|
/**
|
|
Init 'WidgetViewController' instance with a widget.
|
|
|
|
@param widgetUrl the formatted widget url.
|
|
@param widget the widget to open.
|
|
*/
|
|
- (instancetype)initWithUrl:(NSString*)widgetUrl forWidget:(Widget*)widget;
|
|
|
|
/**
|
|
Display an alert over this controller.
|
|
|
|
@param error the error to display.
|
|
*/
|
|
- (void)showErrorAsAlert:(NSError*)error;
|
|
|
|
|
|
#pragma mark - postMessage API
|
|
|
|
/**
|
|
Callback called when the widget make a postMessage API request.
|
|
|
|
This method can be overidden to implement a specific API between the matrix client
|
|
and widget.
|
|
|
|
@param requestId the id of the widget request.
|
|
@param requestData the request data.
|
|
*/
|
|
- (void)onPostMessageRequest:(NSString*)requestId data:(NSDictionary*)requestData;
|
|
|
|
/**
|
|
Send a boolean response to a request from the widget.
|
|
|
|
@param response the response to send.
|
|
@param requestId the id of the widget request.
|
|
*/
|
|
- (void)sendBoolResponse:(BOOL)response toRequest:(NSString*)requestId;
|
|
|
|
/**
|
|
Send an integer response to a request from the widget.
|
|
|
|
@param response the response to send.
|
|
@param requestId the id of the widget request.
|
|
*/
|
|
- (void)sendIntegerResponse:(NSUInteger)response toRequest:(NSString*)requestId;
|
|
|
|
/**
|
|
Send a serialiable object response to a request the widget.
|
|
|
|
@param response the response to send.
|
|
@param requestId the id of the widget request.
|
|
*/
|
|
- (void)sendNSObjectResponse:(NSObject*)response toRequest:(NSString*)requestId;
|
|
|
|
/**
|
|
Send a message error to a request from the widget.
|
|
|
|
@param message the error message.
|
|
@param requestId the id of the widget request.
|
|
*/
|
|
- (void)sendError:(NSString*)message toRequest:(NSString*)requestId;
|
|
|
|
@end
|