NIMQChatMuteModels.h

浏览该文件的文档.

//
//  NIMQChatMuteModels.h
//  NIMQChat
//
//  Created by 陈吉力 on 2024/6/23.
//  Copyright © 2024 Netease. All rights reserved.
//
 
#import <Foundation/Foundation.h>
#import "NIMQChatDefs.h"
#import "NIMQChatChannelMember.h"
#import "NIMQChatServerMember.h"
 
NS_ASSUME_NONNULL_BEGIN
@interface NIMQChatMuteFailedInfo : NSObject
/**
 * 账号
 */
@property (nonatomic, readonly, copy) NSString *accountId;
/**
 * 错误码
 */
@property (nonatomic, readonly, assign) NSInteger errorCode;
/**
 * 错误描述
 */
@property (nonatomic, readonly, copy, nullable) NSString *message;
@end
 
@interface NIMQChatServerMuteParam : NSObject
 
/**
 * 服务器id。必须大于0
 */
@property (nonatomic, assign) unsigned long long serverId;
 
/**
 * 方操作类型。可填写禁言和解禁填写自动解禁或者其他值报参数错误
 */
@property (nonatomic, assign) NIMQChatMuteOperateType operateType;
 
/**
 * 禁言成员列表
 */
@property (nonatomic, strong) NSArray *muteAccountIds;
 
/**
 * 禁言持续时长 单位：秒。大于0合法
 */
@property (nonatomic, assign) NSInteger duration;
 
/**
 * 附言
 */
@property (nonatomic, copy, nullable) NSString *postscript;
 
/**
 * 通知类型。包括只通知被禁言者和全部通知
 */
@property (nonatomic, assign) NIMQChatMuteNotifyScope notifyType;
 
@end
 
@interface NIMQChatChannelMuteParam : NSObject
 
/**
 * 服务器id
 */
@property (nonatomic, assign) unsigned long long serverId;
 
/**
 * 频道id
 */
@property (nonatomic, assign) unsigned long long channelId;
 
/**
 * 操作类型。可填写禁言和解禁填写自动解禁或者其他值报参数错误
 */
@property (nonatomic, assign) NIMQChatMuteOperateType operateType;
 
/**
 * 禁言成员列表
 */
@property (nonatomic, strong) NSArray *muteAccountIds;
 
/**
 * 禁言持续时长 单位：秒。大于0合法
 */
@property (nonatomic, assign) NSInteger duration;
 
/**
 * 附言
 */
@property (nonatomic, copy, nullable) NSString *postscript;
 
/**
 * 通知类型。包括只通知被禁言者和全部通知
 */
@property (nonatomic, assign) NIMQChatMuteNotifyScope notifyType;
 
@end
 
@interface NIMQChatMuteResult : NSObject
 
/**
 * 失败列表，如果全部成功，则没有
 */
@property (nonatomic, strong, readonly, nullable) NSArray<NIMQChatMuteFailedInfo *> *failedList;
@end
 
@interface NIMQChatMuteInfo : NSObject
/**
 * 禁言持续时长 单位：秒
 */
@property (nonatomic, assign, readonly) NSInteger duration;
 
/**
 * 退出禁言时间 单位：毫秒
 */
@property (nonatomic, assign, readonly) NSTimeInterval beReleaseTime;
 
/**
 * 禁言的操作时间 单位：毫秒
 */
@property (nonatomic, assign, readonly) NSTimeInterval muteOperateTime;
 
@end
 
@interface NIMQChatChannelMuteMemberInfo : NIMQChatChannelMember
 
/**
 * 禁言信息
 */
@property (nonatomic, strong, readonly) NIMQChatMuteInfo *muteInfo;
 
@end
 
@interface NIMQChatServerMuteMemberInfo : NIMQChatServerMember
 
/**
 * 禁言信息
 */
@property (nonatomic, strong, readonly) NIMQChatMuteInfo *muteInfo;
 
@end
 
@interface NIMQChatGetServerMuteMemberByPageParam : NSObject
 
/**
 * 服务器id
 */
@property (nonatomic, assign) unsigned long long serverId;
 
/**
 * 分页标记，第一页不传，翻下一页传接口返回的cursor
 */
@property (nonatomic, strong, nullable) NSString *cursor;
 
/**
 * 查询数量限制
 */
@property (nonatomic, assign) NSInteger limit;
 
@end
 
@interface NIMQChatGetChannelMuteMemberByPageParam : NSObject
 
/**
 * 服务器id
 */
@property (nonatomic, assign) unsigned long long serverId;
 
/**
 * 频道id
 */
@property (nonatomic, assign) unsigned long long channelId;
 
/**
 * 分页标记，第一页不传，翻下一页传接口返回的cursor
 */
@property (nonatomic, strong, nullable) NSString *cursor;
 
/**
 * 查询数量限制
 */
@property (nonatomic, assign) NSInteger limit;
 
@end
 
@interface NIMQChatGetServerMuteMemberByPageResult : NSObject
 
/**
 * 是否有下一页
 */
@property (nonatomic, assign, readonly) BOOL hasMore;
 
/**
 * 分页标记，第一页不传，翻下一页传接口返回的cursor
 */
@property (nonatomic, strong, readonly, nullable) NSString *cursor;
 
/**
 * 查询到的成员禁言信息列表
 */
@property (nonatomic, strong, readonly, nullable) NSArray<NIMQChatServerMuteMemberInfo *> *members;
 
@end
 
@interface NIMQChatGetChannelMuteMemberByPageResult : NSObject
 
/**
 * 是否有下一页
 */
@property (nonatomic, assign, readonly) BOOL hasMore;
 
/**
 * 分页标记，第一页不传，翻下一页传接口返回的cursor
 */
@property (nonatomic, strong, readonly, nullable) NSString *cursor;
 
/**
 * 查询到的成员禁言信息列表
 */
@property (nonatomic, strong, readonly, nullable) NSArray<NIMQChatChannelMuteMemberInfo *> *members;
 
@end
 
NS_ASSUME_NONNULL_END