element-ios/Riot/Categories/MXRoom+Riot.h

95 lines
2.6 KiB
C
Raw Normal View History

/*
Copyright 2015 OpenMarket Ltd
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 <MatrixKit/MatrixKit.h>
/**
Define a `MXRoom` category at Vector level.
*/
@interface MXRoom (Vector)
/**
The Riot displayname of the room
*/
@property(nonatomic, readonly) NSString* riotDisplayname;
/**
Tell whether all the notifications are disabled for the room.
*/
@property(nonatomic, readonly, getter=isMute) BOOL mute;
/**
Tell whether the regular notifications are disabled for the room.
*/
@property(nonatomic, readonly, getter=isMentionsOnly) BOOL mentionsOnly;
/*
Observer when a rules deletion fails.
*/
@property (nonatomic) id notificationCenterDidFailObserver;
/*
Observer when a rules deletion succeeds.
*/
@property (nonatomic) id notificationCenterDidUpdateObserver;
/**
Set the room avatar in the dedicated MXKImageView.
The vector style implies to use in order :
1 - the default avatar if there is one
2 - the member avatar for < 3 members rooms
3 - the first later of the room name.
@param mxkImageView the destinated MXKImageView.
*/
- (void)setRoomAvatarImageIn:(MXKImageView*)mxkImageView;
/**
Update the room tag.
@param tag the new tag value
@param completion the block to execute at the end of the operation (independently if it succeeded or not).
You may specify nil for this parameter.
*/
- (void)setRoomTag:(NSString*)tag completion:(void (^)())completion;
/**
Disable all the room notifications.
@param completion the block to execute at the end of the operation (independently if it succeeded or not).
You may specify nil for this parameter.
*/
- (void)mute:(void (^)())completion;
/**
Set the room notifications in mention only mode.
@param completion the block to execute at the end of the operation (independently if it succeeded or not).
You may specify nil for this parameter.
*/
- (void)mentionsOnly:(void (^)())completion;
/**
Enable the room notifications.
@param completion the block to execute at the end of the operation (independently if it succeeded or not).
You may specify nil for this parameter.
*/
- (void)allMessages:(void (^)())completion;
@end