com.jaemon.dingtalk.dinger.annatations.DingerText Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dingtalk-spring-boot-starter Show documentation

集成钉钉机器人实现消息通知

The newest version!

/*
 * Copyright ©2015-2020 Jaemon. All Rights Reserved.
 *
 * 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.
 */
package com.jaemon.dingtalk.dinger.annatations;

import com.jaemon.dingtalk.dinger.enums.AsyncExecuteType;

import java.lang.annotation.*;

/**
 * DingerText
 *
 * 
 *     `@`DingerText(value = "send to dingtalk at ${date}", tokenId = @DingerTokenId("20200906"), phones = {"13520200906"})
 *     void method(@Keyword String keyword, String date) {...}
 * 
 *
 * @author Jaemon
 * @since 2.0
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
@Documented
public @interface DingerText {
    /**
     * text
     *
     * @return send text
     */
    String value();

    /**
     * atAll. either atAll or phones
     *
     * @return whether `@` all members
     */
    boolean atAll() default false;

    /**
     * phones. either atAll or phones
     *
     * @return `@` designated members
     */
    String[] phones() default {};

    /**
     * tokenId
     *
     * @return token info
     */
    DingerTokenId tokenId() default @DingerTokenId("");

    /**
     * asyncExecute
     *
     * @return async execute send
     */
    AsyncExecuteType asyncExecute() default AsyncExecuteType.NONE;
}